kubeclaw/README.md
Marcus (agent-cos) 1a831bdfe5 Initial scaffold: project structure, CRDs, Makefile
- Agent CRD: deployment spec, workspace config, channels, judge integration
- AgentGroup CRD: multi-agent orchestration with shared configs
- JudgePolicy CRD: cluster-scoped authorization policies with per-agent overrides
- Makefile: build, generate, install, test, helm targets
- Go module: controller-runtime + apimachinery dependencies
2026-05-11 20:54:10 -07:00

96 lines
No EOL
2.6 KiB
Markdown

# kubeclaw
OpenClaw operator for Kubernetes.
## What it does
Kubeclaw runs Scobleclaw agents as Kubernetes workloads. It provides:
- **CRDs** for declaring agents, tool bindings, and judge policies as K8s resources
- **Controller** that reconciles desired state → running pods with proper config injection
- **Agent Judge integration** as a K8s admission webhook for per-tool authorization
- **Helm chart** for easy deployment
## Architecture
```
┌─────────────────────────────────────────────┐
│ Kubeclaw Controller Manager │
│ │
│ ┌─────────┐ ┌──────────┐ ┌───────────┐ │
│ │ Agent │ │ Agent │ │ Judge │ │
│ │ Reconciler│ │Group │ │ Webhook │ │
│ │ │ │ Reconciler│ │ Handler │ │
│ └────┬────┘ └────┬─────┘ └─────┬─────┘ │
│ │ │ │ │
│ ┌────▼────┐ ┌────▼─────┐ ┌────▼─────┐ │
│ │ ConfigMap│ │ Secret │ │ Validating│ │
│ │ Generator│ │ Generator│ │ Admission │ │
│ └─────────┘ └──────────┘ └───────────┘ │
└─────────────────────────────────────────────┘
```
## CRDs
### Agent
Defines a single Scobleclaw agent deployment.
```yaml
apiVersion: scobleclaw.ai/v1alpha1
kind: Agent
metadata:
name: marcus-chief-of-staff
spec:
model: deepseek-v4-pro:cloud
workspace:
configMapRef: marcus-workspace
channels:
- discord:
botTokenSecretRef:
name: discord-bot-token
key: token
judge:
enabled: true
model: deepseek-v4-pro:cloud
shadowMode: false
resources:
requests:
memory: "512Mi"
cpu: "250m"
```
### AgentGroup
Manages a group of related agents (e.g., all Scobleclaw departments).
### JudgePolicy
Defines authorization policies for the Agent Judge admission webhook.
## Quick Start
```bash
# Install CRDs
make install
# Run controller locally
make run
# Deploy to cluster
helm install kubeclaw ./charts/kubeclaw
```
## Development
```bash
# Generate CRD manifests and client code
make generate
# Run tests
make test
# Build manager binary
make build
```
## License
MIT