https://github.com/weak-fox/openclaw-helm
Helm packaging for OpenClaw on Kubernetes with aio-sandbox integration and flexible model/provider configuration.
https://github.com/weak-fox/openclaw-helm
Last synced: about 2 months ago
JSON representation
Helm packaging for OpenClaw on Kubernetes with aio-sandbox integration and flexible model/provider configuration.
- Host: GitHub
- URL: https://github.com/weak-fox/openclaw-helm
- Owner: weak-fox
- License: mit
- Created: 2026-02-28T17:28:12.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-05-21T21:58:20.000Z (about 2 months ago)
- Last Synced: 2026-05-22T06:29:48.466Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 4.94 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
openclaw-helm
Helm packaging for OpenClaw on Kubernetes.
Focused on practical security controls and flexible model/provider configuration.
Quick Start •
Examples •
Compatibility •
Architecture •
Demo •
Repo Layout •
Artifact Hub •
References
## Highlights
- Flexible model/provider setup with clear keys (`provider` / `api` / `baseUrl` / `model`).
- Security switches exposed through `gateway.controlUi` for different deployment policies.
- Integrated `aio-sandbox` with shared workspace storage:
browser actions are visible, workspace config can be updated through browser flows, and shell/Jupyter tasks run in the same runtime.
- Built-in offline seed bootstrap for skills/plugins via [`weak-fox/openclaw-offline-seed`](https://github.com/weak-fox/openclaw-offline-seed),
so startup can use pre-bundled artifacts without runtime `npx` downloads.
- Unified image registry prefixing through `global.imageRegistry`.
- CI/release workflows included for linting, templating, and chart publishing.
## Compatibility
| Item | Version |
| --- | --- |
| Chart | `1.0.43` |
| OpenClaw app | `2026.5.27` |
| Kubernetes | `>=1.24.0-0` |
| Helm | `v3.x` |
Source of truth: `charts/openclaw/Chart.yaml`.
## Architecture
```mermaid
flowchart TB
subgraph A["Access"]
U["Browser / API Client"]
SVC["Service / Ingress"]
end
subgraph B["Runtime Pod"]
GW["OpenClaw Gateway
:18789"]
SB["aio-sandbox
:8080"]
end
subgraph C["Dependencies"]
LLM["Model Provider"]
VOL["Shared Storage (PVC)"]
end
U --> SVC --> GW
GW <--> SB
GW --> LLM
GW <--> VOL
SB <--> VOL
classDef access fill:#EEF6FF,stroke:#5B8FF9,stroke-width:1.2px,color:#0B1F33;
classDef runtime fill:#FFF4E8,stroke:#FA8C16,stroke-width:1.2px,color:#2B1A00;
classDef dep fill:#F6FFED,stroke:#52C41A,stroke-width:1.2px,color:#102A00;
class U,SVC access;
class GW,SB runtime;
class LLM,VOL dep;
```
## Quick start
`OPENCLAW_API_KEY` is the unified runtime provider key consumed by OpenClaw provider config.
Put your provider key in this secret (OpenAI / Anthropic / LiteLLM / OpenRouter / vLLM gateway / Ollama gateway, etc.).
Create namespace and API key secret first (required):
```bash
kubectl create namespace openclaw
kubectl -n openclaw create secret generic openclaw-api-key \
--from-literal=OPENCLAW_API_KEY=sk-xxxx
```
Install directly from local chart path (test profile):
```bash
helm upgrade --install openclaw ./charts/openclaw -n openclaw \
--set gateway.controlUi.allowInsecureAuth=true \
--set gateway.controlUi.dangerouslyDisableDeviceAuth=true \
--set gateway.controlUi.dangerouslyAllowHostHeaderOriginFallback=true
```
Install from Helm repository (test profile):
```bash
helm repo add openclaw-helm https://weak-fox.github.io/openclaw-helm
helm repo update
helm upgrade --install openclaw openclaw-helm/openclaw -n openclaw \
--set gateway.controlUi.allowInsecureAuth=true \
--set gateway.controlUi.dangerouslyDisableDeviceAuth=true \
--set gateway.controlUi.dangerouslyAllowHostHeaderOriginFallback=true
```
> Warning
> The three `gateway.controlUi.*` flags above reduce security and are for local testing only.
> For production/security-sensitive deployments, follow OpenClaw official guidance:
> https://docs.openclaw.ai/gateway/security
Full values and operations guide: [charts/openclaw/README.md](charts/openclaw/README.md)
## Examples
All example values are here: [charts/openclaw/examples](charts/openclaw/examples)
Example usage:
```bash
helm upgrade --install openclaw ./charts/openclaw -n openclaw \
-f ./charts/openclaw/examples/.yaml
```
## Browser workflow demo
Captured from a real Kubernetes deployment with LiteLLM (`Qwen3`) backend, using `aio-sandbox` and shared storage to drive browser operations and workspace-level execution.
## Repository layout
- Chart source: [charts/openclaw](charts/openclaw)
- Chart docs: [charts/openclaw/README.md](charts/openclaw/README.md)
- License: [LICENSE](LICENSE)
- Third-party notices: [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)
- Workflows:
- [helm-ci.yaml](.github/workflows/helm-ci.yaml)
- [chart-release.yaml](.github/workflows/chart-release.yaml)
- [sync-openclaw-release.yaml](.github/workflows/sync-openclaw-release.yaml)
## Publishing chart repo
Enable GitHub Pages on `gh-pages` (root).
When chart-related changes are pushed to `main` (or a GitHub Release is published), `chart-release.yaml` runs `helm/chart-releaser-action` to publish:
- GitHub Release assets (`.tgz`)
- Helm repo index (`gh-pages/index.yaml`)
Then clients can install/update by:
```bash
helm repo add openclaw-helm https://weak-fox.github.io/openclaw-helm
helm repo update
```
## Artifact Hub
This repo is prepared for Artifact Hub onboarding.
1. Publish chart index on GitHub Pages (`https://weak-fox.github.io/openclaw-helm/index.yaml`).
2. Register the Helm repo in Artifact Hub (repository URL above).
3. After Artifact Hub creates your repository entry, add root metadata file `artifacthub-repo.yml`.
4. Keep the metadata file synced to `gh-pages` so Artifact Hub can read it from the chart repository root.
## References and integrations
- Integrated sandbox runtime: [`agent-infra/sandbox`](https://github.com/agent-infra/sandbox)
- Offline seed image project: [`weak-fox/openclaw-offline-seed`](https://github.com/weak-fox/openclaw-offline-seed)
- Referenced Helm implementation patterns: [`serhanekicii/openclaw-helm`](https://github.com/serhanekicii/openclaw-helm)
For attribution and license details of referenced/derived parts, see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).