Kubernetes

Add the chart repository#

bouine publishes a Helm chart repository at https://charts.bouine.org, indexed on Artifact Hub. The chart pulls the bouinecache/bouine image from Docker Hub by default.

helm repo add bouine https://charts.bouine.org
helm repo update
helm search repo bouine

NAME            CHART VERSION   APP VERSION     DESCRIPTION
bouine/bouine   0.1.0           0.1.0           Cloud-native HTTP cache in Go ...

Helm quickstart#

helm install bouine bouine/bouine \
  --namespace bouine --create-namespace \
  --set "config.upstream_pools[0].name=app" \
  --set "config.upstream_pools[0].targets[0]=app.default.svc:8080" \
  --set "config.routes[0].pool=app"

This deploys a StatefulSet with gossip clustering, a headless Service for peer discovery, and a PodDisruptionBudget.

To install from a local checkout instead of the repository, point Helm at the chart directory:

helm install bouine deploy/helm/bouine --namespace bouine --create-namespace ...

See Helm chart reference for all configurable values.

StatefulSet requirements#

For multi-pod clustering, use a StatefulSet and a headless Service with publishNotReadyAddresses: true. See Clustering → Headless Service for the full manifest.

Admin token (multi-pod requirement)#

All pods must share the same admin.token. See Authentication for setup instructions.

Scaling#

kubectl scale statefulset/bouine -n bouine --replicas=3
kubectl exec bouine-0 -n bouine -- /bouine cluster peers

Rolling updates#

kubectl rollout restart statefulset/bouine -n bouine
kubectl rollout status statefulset/bouine -n bouine

bouine marks itself not-ready during shutdown and leaves the gossip cluster cleanly. See Kubernetes operations for zero-5xx rolling update procedures.