Skip to main content

Run on Kubernetes

The Zaris Helm chart deploys a Zaris cluster to Kubernetes as a StatefulSet, with the Management Service and the client endpoints exposed as Services. The chart serves a store natively, so there is no store-creation step — the store is ready as soon as the cluster is up. The client API is the same one every other mode uses.

Prerequisites​

You need a Kubernetes cluster and the kubectl and helm (v3) command-line tools configured to talk to it. Any conformant cluster works, including a local one such as kind or minikube.

1. Install the chart​

Install the chart from the OCI registry into its own namespace, with three nodes and a replication factor of two:

helm install zaris oci://registry-1.docker.io/clustron/zaris \
  --namespace zaris --create-namespace \
  --set node.replicas=3 --set node.replicationFactor=2
note

The OCI path oci://registry-1.docker.io/clustron/zaris is the intended publish location. Until the images and chart are published, install from the chart archive in the release bundle instead:

helm install zaris ./zaris-0.1.0.tgz \
  --namespace zaris --create-namespace \
  --set node.replicas=3 --set node.replicationFactor=2

2. Wait for the cluster​

Wait for the StatefulSet to finish rolling out:

kubectl -n zaris rollout status statefulset/zaris

3. Connect​

The chart serves a store whose name equals the cluster id — zaris-k8s by default — so no store-creation step is needed.

From a workload running inside the cluster, connect through the client Service:

zaris://zaris-client.zaris.svc.cluster.local:7861/zaris-k8s

For access from outside the cluster, Zaris uses TLS on the advertised external port:

zariss://<external-host>:7863/zaris-k8s?ca=/path/to/ca.pem

External access requires the external listener to be enabled and a CA certificate for the client to trust. See Kubernetes deployment and Secured client connect for the full setup.

4. Tear down​

Remove the release:

helm uninstall zaris -n zaris

What you just did​

You deployed a Zaris cluster to Kubernetes with Helm, with a store ready to use the moment the StatefulSet finished rolling out. Connecting is just a connection string — the same client API as every other mode.

Next steps​