Skip to main content

Chart installation

Fresh install​

helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update

# OCI (once chart published):
helm install openbox oci://ghcr.io/openbox-ai/charts/openbox \
  --version 0.1.0 \
  -n openbox --create-namespace \
  -f my-values.yaml \
  --atomic --wait --timeout 15m

# Or from local checkout:
git clone https://github.com/OpenBox-AI/openbox-manifest-k8s-cluster.git
cd openbox-manifest-k8s-cluster
helm dependency update charts/openbox
helm install openbox charts/openbox \
  -n openbox --create-namespace \
  -f my-values.yaml \
  --atomic --wait --timeout 15m

Upgrade​

helm upgrade openbox charts/openbox \
  -n openbox \
  -f my-values.yaml \
  --atomic --wait --timeout 15m
  • --atomic — auto-rolls back on failure
  • --wait — blocks until all pods Ready
  • --timeout 15m — first-run Aurora/EKS provisioning can take up to 15 min; scale later runs down to --timeout 5m

Rollback​

helm history openbox -n openbox
# List revisions with status (deployed, superseded, failed)

helm rollback openbox <revision> -n openbox
# Or roll back one step:
helm rollback openbox 0 -n openbox

Rollback restores Kubernetes resources but not database schema — if the upgrade ran migrations, coordinate with your DBA before rolling back.

Uninstall​

helm uninstall openbox -n openbox

# Also delete the namespace + PVCs (PVCs contain your data — back up first!)
kubectl delete namespace openbox

For a clean re-install: helm uninstall, wait for pods to fully terminate, delete PVCs manually if needed.

Dry-run (preview without applying)​

helm upgrade --install openbox charts/openbox \
  -n openbox \
  -f my-values.yaml \
  --dry-run --debug > preview.yaml

Review the rendered manifests before commit.

Idempotent upgrade in CI/CD​

helm upgrade --install openbox charts/openbox \
  -n openbox --create-namespace \
  -f my-values.yaml \
  --atomic --wait --timeout 15m \
  --history-max 10          # cap revision history to save etcd

Values precedence (lowest → highest)​

  1. Chart values.yaml (built-in defaults)
  2. Sub-chart values.yaml (per sub-chart defaults)
  3. -f my-values.yaml (customer overrides)
  4. --set key=value (CLI overrides)
  5. --set-file key=@path (multi-line values)

Prefer -f my-values.yaml for anything that must be version-controlled.

Values reference​

Every top-level key is documented at Values reference.