Apache ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.
- Kubernetes 1.24+
- Helm 3.2.0+
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
To install the chart with the release name my-zookeeper:
helm install my-zookeeper oci://registry-1.docker.io/cloudpirates/zookeeperTo install with custom values:
helm install my-zookeeper oci://registry-1.docker.io/cloudpirates/zookeeper -f my-values.yamlOr install directly from the local chart:
helm install my-zookeeper ./charts/zookeeperThe command deploys Zookeeper on the Kubernetes cluster in the default configuration. The Configuration section lists the parameters that can be configured during installation.
This Helm chart is cryptographically signed with Cosign to ensure authenticity and prevent tampering.
Public Key:
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE5U+rM2d3hDjgP5T3cLShuuQIU9vR
Z4/G+Nug6q5vRa+C3qUA1wXjbaJFAfcIrv5VjmYAYOj13shnPpp3Zh4fnQ==
-----END PUBLIC KEY-----
To verify the helm chart before installation, copy the public key to the file cosign.pub and run cosign:
cosign verify --key cosign.pub registry-1.docker.io/cloudpirates/zookeeper:<version>- Connect to ZooKeeper from inside the cluster:
kubectl run zk-client --rm --tty -i --restart='Never' \
--image zookeeper:latest -- bash
# Inside the pod:
zkCli.sh -server my-zookeeper:2181| Parameter | Description | Default |
|---|---|---|
global.imageRegistry |
Global Docker image registry | "" |
global.imagePullSecrets |
Global Docker registry secret names as an array | [] |
| Parameter | Description | Default |
|---|---|---|
image.registry |
ZooKeeper image registry | docker.io |
image.repository |
ZooKeeper image repository | zookeeper |
image.tag |
ZooKeeper image tag | 3.9.4@sha256:2408ba6f6eb91a4dbf65548428b90f9e5e9cf9d77e5f280a4bf80270d465a80f |
image.imagePullPolicy |
ZooKeeper image pull policy | Always |
| Parameter | Description | Default |
|---|---|---|
nameOverride |
String to partially override fullname | "" |
fullnameOverride |
String to fully override fullname | "" |
namespaceOverride |
String to override the namespace for all resources | "" |
commonLabels |
Labels to add to all deployed objects | {} |
commonAnnotations |
Annotations to add to all deployed objects | {} |
replicaCount |
Number of ZooKeeper replicas to deploy | 3 |
podDisruptionBudget.enabled |
Create a Pod Disruption Budget to ensure high availability during voluntary disruptions | true |
podDisruptionBudget.minAvailable |
minAvailable for Pod Disruption Budget. Value is not mandatory. | "" |
podDisruptionBudget.maxUnavailable |
minAvailable for Pod Disruption Budget. Value is not mandatory. | "" |
networkPolicy.enabled |
Enable network policies | true |
command |
Override default container command (useful when the default entrypoint needs to be replaced) | [] |
| Parameter | Description | Default |
|---|---|---|
zookeeperConfig.tickTime |
ZooKeeper tick time | 2000 |
zookeeperConfig.initLimit |
ZooKeeper init limit | 10 |
zookeeperConfig.syncLimit |
ZooKeeper sync limit | 5 |
zookeeperConfig.electionPortBindRetry |
ZooKeeper election port bind retry | 10 |
zookeeperConfig.maxClientCnxns |
ZooKeeper max client connections | 60 |
zookeeperConfig.standaloneEnabled |
Enable standalone mode | "false" |
zookeeperConfig.adminServerEnabled |
Enable admin server | "false" |
zookeeperConfig.commandsWhitelist |
4-letter word commands whitelist | srvr |
zookeeperConfig.autopurge.purgeInterval |
Autopurge purge interval (hours) | 24 |
zookeeperConfig.autopurge.snapRetainCount |
Autopurge snapshot retain count | 3 |
zookeeperConfig.admin.enableServer |
Enable the admin server | "false" |
zookeeperConfig.admin.serverPort |
Admin server port | 8080 |
zookeeperConfig.admin.serverAddress |
Admin server address | 0.0.0.0 |
zookeeperConfig.admin.idleTimeout |
Admin server connection idle timeout (milliseconds) | 30000 |
zookeeperConfig.admin.commandUrl |
Admin server command URL | /commands |
| Parameter | Description | Default |
|---|---|---|
metrics.enabled |
Enable Prometheus metrics exporter | true |
metrics.service.type |
Metrics service type | ClusterIP |
metrics.service.ports.port |
Metrics service port | 7000 |
metrics.service.annotations |
Additional custom annotations for Metrics service | {} |
metrics.service.labels |
Additional labels for metrics service | {} |
metrics.serviceMonitor.enabled |
Create ServiceMonitor resource(s) for scraping metrics using Prometheus Operator | false |
metrics.serviceMonitor.namespace |
Namespace in which to create ServiceMonitor resource(s) | "" |
metrics.serviceMonitor.interval |
Interval at which metrics should be scraped | 10s |
metrics.serviceMonitor.scrapeTimeout |
Timeout after which the scrape is ended | "" |
metrics.serviceMonitor.relabelings |
Additional relabeling of metrics | [] |
metrics.serviceMonitor.metricRelabelings |
Additional metric relabeling of metrics | [] |
metrics.serviceMonitor.honorLabels |
Honor metrics labels | false |
metrics.serviceMonitor.selector |
Prometheus instance selector labels | {} |
metrics.serviceMonitor.annotations |
Additional custom annotations for the ServiceMonitor | {} |
metrics.serviceMonitor.namespaceSelector |
Namespace selector for ServiceMonitor | {} |
| Parameter | Description | Default |
|---|---|---|
service.type |
Kubernetes service type | ClusterIP |
service.ports.client |
ZooKeeper client service port | 2181 |
service.ports.quorum |
ZooKeeper quorum service port | 2888 |
service.ports.leaderElection |
ZooKeeper leader election service port | 3888 |
service.ports.admin |
ZooKeeper admin service port | 8080 |
service.annotations |
Additional annotations to add to the service | {} |
| Parameter | Description | Default |
|---|---|---|
persistence.enabled |
Enable persistence using PVC | true |
persistence.storageClass |
Persistent Volume storage class | "" |
persistence.annotations |
Persistent Volume Claim annotations | {} |
persistence.size |
Persistent Volume size | 8Gi |
persistence.accessModes |
Persistent Volume access modes | [ReadWriteOnce] |
persistence.existingClaim |
Name of existing PVC to use | "" |
persistence.mountPath |
Path to mount the data volume | /data |
persistence.dataDir |
The directory where to store the data | /data |
| Parameter | Description | Default |
|---|---|---|
resources |
Resource requests/limits | {} (user-defined) |
| Parameter | Description | Default |
|---|---|---|
nodeSelector |
Node selector for pod assignment | {} |
priorityClassName |
Priority class name for pod eviction | "" |
tolerations |
Tolerations for pod assignment | [] |
affinity |
Affinity rules for pod assignment | {} |
| Parameter | Description | Default |
|---|---|---|
containerSecurityContext.runAsUser |
User ID to run the container process | 1000 |
containerSecurityContext.runAsGroup |
Group ID to run the container process | 1000 |
containerSecurityContext.seLinuxOptions |
SELinux options for the container | {} |
containerSecurityContext.runAsNonRoot |
Require the container to run as a non-root user | true |
containerSecurityContext.allowPrivilegeEscalation |
Whether to allow privilege escalation for the container | false |
containerSecurityContext.privileged |
Set container's privileged mode | false |
containerSecurityContext.readOnlyRootFilesystem |
Mount container root filesystem as read-only | false |
containerSecurityContext.capabilities |
Linux capabilities to drop or add for the container | {} |
containerSecurityContext.seccompProfile |
Seccomp profile for the container | {} |
podSecurityContext.fsGroup |
Group ID for the volumes of the pod | 1000 |
| Parameter | Description | Default |
|---|---|---|
livenessProbe.enabled |
Enable livenessProbe | true |
livenessProbe.initialDelaySeconds |
LivenessProbe initial delay | 30 |
livenessProbe.periodSeconds |
LivenessProbe period seconds | 10 |
livenessProbe.timeoutSeconds |
LivenessProbe timeout seconds | 5 |
livenessProbe.failureThreshold |
LivenessProbe failure threshold | 6 |
livenessProbe.successThreshold |
LivenessProbe success threshold | 1 |
| Parameter | Description | Default |
|---|---|---|
readinessProbe.enabled |
Enable readinessProbe | true |
readinessProbe.initialDelaySeconds |
ReadinessProbe initial delay | 5 |
readinessProbe.periodSeconds |
ReadinessProbe period seconds | 10 |
readinessProbe.timeoutSeconds |
ReadinessProbe timeout seconds | 5 |
readinessProbe.failureThreshold |
ReadinessProbe failure threshold | 6 |
readinessProbe.successThreshold |
ReadinessProbe success threshold | 1 |
| Parameter | Description | Default |
|---|---|---|
startupProbe.enabled |
Enable startupProbe | false |
startupProbe.initialDelaySeconds |
StartupProbe initial delay | 10 |
startupProbe.periodSeconds |
StartupProbe period seconds | 10 |
startupProbe.timeoutSeconds |
StartupProbe timeout seconds | 5 |
startupProbe.failureThreshold |
StartupProbe failure threshold | 30 |
startupProbe.successThreshold |
StartupProbe success threshold | 1 |
| Parameter | Description | Default |
|---|---|---|
extraEnvVars |
Additional environment variables to set | [] |
extraVolumes |
Additional volumes to add to the pod | [] |
extraVolumeMounts |
Additional volume mounts | [] |
extraObjects |
Array of extra objects to deploy | [] |
See values.yaml for the full list of configurable parameters.
You can use the extraObjects array to deploy additional Kubernetes resources (such as NetworkPolicies, ConfigMaps, etc.) alongside the release. This is useful for customizing your deployment with extra manifests that are not covered by the default chart options.
Helm templating is supported in any field, but all template expressions must be quoted. For example, to use the release namespace, write namespace: "{{ .Release.Namespace }}".
Example: Deploy a NetworkPolicy with templating
extraObjects:
- apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
name: allow-dns
namespace: "{{ .Release.Namespace }}"
spec:
podSelector: {}
policyTypes:
- Egress
egress:
- to:
- namespaceSelector:
matchLabels:
kubernetes.io/metadata.name: kube-system
podSelector:
matchLabels:
k8s-app: kube-dns
- ports:
- port: 53
protocol: UDP
- port: 53
protocol: TCPTo upgrade your ZooKeeper installation:
helm upgrade my-zookeeper ./charts/zookeeperTo uninstall/delete the ZooKeeper deployment:
helm delete my-zookeeperFor issues related to this Helm chart, please check: