Skip to content

niklasfrick/zeroclaw-helm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zeroclaw-helm

Lint and Test Charts Release Charts Artifact Hub

Helm chart for deploying ZeroClaw on Kubernetes.

Installation

helm repo add zeroclaw https://niklasfrick.github.io/zeroclaw-helm
helm repo update
helm install zeroclaw zeroclaw/zeroclaw --set secret.apiKey="sk-..."

Or with an existing Kubernetes secret:

helm install zeroclaw zeroclaw/zeroclaw \
  --set secret.create=false \
  --set secret.existingSecret=zeroclaw-api \
  --set secret.existingSecretKey=API_KEY

From source (development)

helm install zeroclaw ./chart/zeroclaw --set secret.apiKey="sk-..."

Features

  • Gateway & Daemon modes — run as a webhook-only server or a full autonomous runtime with channels (Telegram, Discord, etc.)
  • Config-driven — provider, model, pairing, and bind settings via values.yaml
  • Persistent storage — data volume at /zeroclaw-data backed by a PVC
  • Ingress & Gateway API — first-class support for both Ingress and HTTPRoute
  • Security defaults — runs as non-root with dropped capabilities

Configuration

All configuration is done through Helm values. Key settings:

Value Default Description
config.mode gateway gateway (webhook only) or daemon
config.provider openrouter LLM provider
config.model "" Model override (default: claude-sonnet-4-5-20250929)
secret.apiKey "" API key (creates a Kubernetes Secret)
persistence.size 10Gi PVC size for /zeroclaw-data

See the full values reference and examples in chart/zeroclaw/README.md.

Development

# Lint
helm lint ./chart/zeroclaw

# Dry-run render
helm template zeroclaw ./chart/zeroclaw

# Install (local cluster)
helm install zeroclaw ./chart/zeroclaw --set secret.apiKey="sk-..."

# Upgrade
helm upgrade zeroclaw ./chart/zeroclaw -f my-values.yaml

# Uninstall
helm uninstall zeroclaw

CI/CD

This repository uses GitHub Actions for continuous integration and release automation:

  • Pull Requests — every PR to main runs chart linting (chart-testing), template rendering with multiple value combinations, and schema validation with kubeconform. A kind cluster is spun up for install testing.
  • Merge to main — automatically determines the next SemVer version from Conventional Commits, updates Chart.yaml, packages the chart, creates a GitHub Release, and publishes to the Helm repository hosted on GitHub Pages.

Versioning

Commit messages on main drive automatic version bumps:

Commit prefix Bump Example
fix: Patch fix: correct probe path
feat: Minor feat: add ServiceMonitor
feat!: / BREAKING CHANGE Major feat!: rename values root key

Repository Setup

To enable the Helm repository on GitHub Pages:

  1. Go to Settings > Pages in this repository.
  2. Set Source to Deploy from a branch.
  3. Set Branch to gh-pages and path to / (root).
  4. Save.

The release workflow will create the gh-pages branch automatically on the first release.

License

See LICENSE.

About

A Helm Chart for ZeroClaw to deploy on Kubernetes

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •