Apache ZooKeeper packaged by VMware - View the list of available chart parameters

The chart supports the parameters shown below.

NOTE: These parameters apply to chart version 11.4.1.

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []
global.storageClass Global StorageClass for Persistent Volume(s) ""

Common parameters

Name Description Value
kubeVersion Override Kubernetes version ""
nameOverride String to partially override common.names.fullname template (will maintain the release name) ""
fullnameOverride String to fully override common.names.fullname template ""
clusterDomain Kubernetes Cluster Domain cluster.local
extraDeploy Extra objects to deploy (evaluated as a template) []
commonLabels Add labels to all the deployed resources {}
commonAnnotations Add annotations to all the deployed resources {}
namespaceOverride Override namespace for ZooKeeper resources ""
diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden) false
diagnosticMode.command Command to override all containers in the statefulset ["sleep"]
diagnosticMode.args Args to override all containers in the statefulset ["infinity"]

ZooKeeper chart parameters

Name Description Value
image.registry ZooKeeper image registry docker.io
image.repository ZooKeeper image repository bitnami/zookeeper
image.tag ZooKeeper image tag (immutable tags are recommended)
image.digest ZooKeeper image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
image.pullPolicy ZooKeeper image pull policy IfNotPresent
image.pullSecrets Specify docker-registry secret names as an array []
image.debug Specify if debug values should be set false
auth.client.enabled Enable ZooKeeper client-server authentication. It uses SASL/Digest-MD5 false
auth.client.clientUser User that will use ZooKeeper clients to auth ""
auth.client.clientPassword Password that will use ZooKeeper clients to auth ""
auth.client.serverUsers Comma, semicolon or whitespace separated list of user to be created ""
auth.client.serverPasswords Comma, semicolon or whitespace separated list of passwords to assign to users when created ""
auth.client.existingSecret Use existing secret (ignores previous passwords) ""
auth.quorum.enabled Enable ZooKeeper server-server authentication. It uses SASL/Digest-MD5 false
auth.quorum.learnerUser User that the ZooKeeper quorumLearner will use to authenticate to quorumServers. ""
auth.quorum.learnerPassword Password that the ZooKeeper quorumLearner will use to authenticate to quorumServers. ""
auth.quorum.serverUsers Comma, semicolon or whitespace separated list of users for the quorumServers. ""
auth.quorum.serverPasswords Comma, semicolon or whitespace separated list of passwords to assign to users when created ""
auth.quorum.existingSecret Use existing secret (ignores previous passwords) ""
tickTime Basic time unit (in milliseconds) used by ZooKeeper for heartbeats 2000
initLimit ZooKeeper uses to limit the length of time the ZooKeeper servers in quorum have to connect to a leader 10
syncLimit How far out of date a server can be from a leader 5
preAllocSize Block size for transaction log file 65536
snapCount The number of transactions recorded in the transaction log before a snapshot can be taken (and the transaction log rolled) 100000
maxClientCnxns Limits the number of concurrent connections that a single client may make to a single member of the ZooKeeper ensemble 60
maxSessionTimeout Maximum session timeout (in milliseconds) that the server will allow the client to negotiate 40000
heapSize Size (in MB) for the Java Heap options (Xmx and Xms) 1024
fourlwCommandsWhitelist A list of comma separated Four Letter Words commands that can be executed srvr, mntr, ruok
minServerId Minimal SERVER_ID value, nodes increment their IDs respectively 1
listenOnAllIPs Allow ZooKeeper to listen for connections from its peers on all available IP addresses false
autopurge.snapRetainCount The most recent snapshots amount (and corresponding transaction logs) to retain 3
autopurge.purgeInterval The time interval (in hours) for which the purge task has to be triggered 0
logLevel Log level for the ZooKeeper server. ERROR by default ERROR
jvmFlags Default JVM flags for the ZooKeeper process ""
dataLogDir Dedicated data log directory ""
configuration Configure ZooKeeper with a custom zoo.cfg file ""
existingConfigmap The name of an existing ConfigMap with your custom configuration for ZooKeeper ""
extraEnvVars Array with extra environment variables to add to ZooKeeper nodes []
extraEnvVarsCM Name of existing ConfigMap containing extra env vars for ZooKeeper nodes ""
extraEnvVarsSecret Name of existing Secret containing extra env vars for ZooKeeper nodes ""
command Override default container command (useful when using custom images) ["/scripts/setup.sh"]
args Override default container args (useful when using custom images) []

Statefulset parameters

Name Description Value
replicaCount Number of ZooKeeper nodes 1
containerPorts.client ZooKeeper client container port 2181
containerPorts.tls ZooKeeper TLS container port 3181
containerPorts.follower ZooKeeper follower container port 2888
containerPorts.election ZooKeeper election container port 3888
livenessProbe.enabled Enable livenessProbe on ZooKeeper containers true
livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 30
livenessProbe.periodSeconds Period seconds for livenessProbe 10
livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
livenessProbe.failureThreshold Failure threshold for livenessProbe 6
livenessProbe.successThreshold Success threshold for livenessProbe 1
livenessProbe.probeCommandTimeout Probe command timeout for livenessProbe 2
readinessProbe.enabled Enable readinessProbe on ZooKeeper containers true
readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
readinessProbe.periodSeconds Period seconds for readinessProbe 10
readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
readinessProbe.failureThreshold Failure threshold for readinessProbe 6
readinessProbe.successThreshold Success threshold for readinessProbe 1
readinessProbe.probeCommandTimeout Probe command timeout for readinessProbe 2
startupProbe.enabled Enable startupProbe on ZooKeeper containers false
startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 30
startupProbe.periodSeconds Period seconds for startupProbe 10
startupProbe.timeoutSeconds Timeout seconds for startupProbe 1
startupProbe.failureThreshold Failure threshold for startupProbe 15
startupProbe.successThreshold Success threshold for startupProbe 1
customLivenessProbe Custom livenessProbe that overrides the default one {}
customReadinessProbe Custom readinessProbe that overrides the default one {}
customStartupProbe Custom startupProbe that overrides the default one {}
lifecycleHooks for the ZooKeeper container(s) to automate configuration before or after startup {}
resources.limits The resources limits for the ZooKeeper containers {}
resources.requests.memory The requested memory for the ZooKeeper containers 256Mi
resources.requests.cpu The requested cpu for the ZooKeeper containers 250m
podSecurityContext.enabled Enabled ZooKeeper pods' Security Context true
podSecurityContext.fsGroup Set ZooKeeper pod's Security Context fsGroup 1001
containerSecurityContext.enabled Enabled ZooKeeper containers' Security Context true
containerSecurityContext.runAsUser Set ZooKeeper containers' Security Context runAsUser 1001
containerSecurityContext.runAsNonRoot Set ZooKeeper containers' Security Context runAsNonRoot true
containerSecurityContext.allowPrivilegeEscalation Force the child process to be run as nonprivilege false
hostAliases ZooKeeper pods host aliases []
podLabels Extra labels for ZooKeeper pods {}
podAnnotations Annotations for ZooKeeper pods {}
podAffinityPreset Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard ""
podAntiAffinityPreset Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard soft
nodeAffinityPreset.type Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard ""
nodeAffinityPreset.key Node label key to match Ignored if affinity is set. ""
nodeAffinityPreset.values Node label values to match. Ignored if affinity is set. []
affinity Affinity for pod assignment {}
nodeSelector Node labels for pod assignment {}
tolerations Tolerations for pod assignment []
topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
podManagementPolicy StatefulSet controller supports relax its ordering guarantees while preserving its uniqueness and identity guarantees. There are two valid pod management policies: OrderedReady and Parallel Parallel
priorityClassName Name of the existing priority class to be used by ZooKeeper pods, priority class needs to be created beforehand ""
schedulerName Kubernetes pod scheduler registry ""
updateStrategy.type ZooKeeper statefulset strategy type RollingUpdate
updateStrategy.rollingUpdate ZooKeeper statefulset rolling update configuration parameters {}
extraVolumes Optionally specify extra list of additional volumes for the ZooKeeper pod(s) []
extraVolumeMounts Optionally specify extra list of additional volumeMounts for the ZooKeeper container(s) []
sidecars Add additional sidecar containers to the ZooKeeper pod(s) []
initContainers Add additional init containers to the ZooKeeper pod(s) []
pdb.create Deploy a pdb object for the ZooKeeper pod false
pdb.minAvailable Minimum available ZooKeeper replicas ""
pdb.maxUnavailable Maximum unavailable ZooKeeper replicas 1

Traffic Exposure parameters

Name Description Value
service.type Kubernetes Service type ClusterIP
service.ports.client ZooKeeper client service port 2181
service.ports.tls ZooKeeper TLS service port 3181
service.ports.follower ZooKeeper follower service port 2888
service.ports.election ZooKeeper election service port 3888
service.nodePorts.client Node port for clients ""
service.nodePorts.tls Node port for TLS ""
service.disableBaseClientPort Remove client port from service definitions. false
service.sessionAffinity Control where client requests go, to the same pod or round-robin None
service.sessionAffinityConfig Additional settings for the sessionAffinity {}
service.clusterIP ZooKeeper service Cluster IP ""
service.loadBalancerIP ZooKeeper service Load Balancer IP ""
service.loadBalancerSourceRanges ZooKeeper service Load Balancer sources []
service.externalTrafficPolicy ZooKeeper service external traffic policy Cluster
service.annotations Additional custom annotations for ZooKeeper service {}
service.extraPorts Extra ports to expose in the ZooKeeper service (normally used with the sidecar value) []
service.headless.annotations Annotations for the Headless Service {}
service.headless.publishNotReadyAddresses If the ZooKeeper headless service should publish DNS records for not ready pods true
service.headless.servicenameOverride String to partially override headless service name ""
networkPolicy.enabled Specifies whether a NetworkPolicy should be created false
networkPolicy.allowExternal Don't require client label for connections true

Other Parameters

Name Description Value
serviceAccount.create Enable creation of ServiceAccount for ZooKeeper pod false
serviceAccount.name The name of the ServiceAccount to use. ""
serviceAccount.automountServiceAccountToken Allows auto mount of ServiceAccountToken on the serviceAccount created true
serviceAccount.annotations Additional custom annotations for the ServiceAccount {}

Persistence parameters

Name Description Value
persistence.enabled Enable ZooKeeper data persistence using PVC. If false, use emptyDir true
persistence.existingClaim Name of an existing PVC to use (only when deploying a single replica) ""
persistence.storageClass PVC Storage Class for ZooKeeper data volume ""
persistence.accessModes PVC Access modes ["ReadWriteOnce"]
persistence.size PVC Storage Request for ZooKeeper data volume 8Gi
persistence.annotations Annotations for the PVC {}
persistence.labels Labels for the PVC {}
persistence.selector Selector to match an existing Persistent Volume for ZooKeeper's data PVC {}
persistence.dataLogDir.size PVC Storage Request for ZooKeeper's dedicated data log directory 8Gi
persistence.dataLogDir.existingClaim Provide an existing PersistentVolumeClaim for ZooKeeper's data log directory ""
persistence.dataLogDir.selector Selector to match an existing Persistent Volume for ZooKeeper's data log PVC {}

Volume Permissions parameters

Name Description Value
volumePermissions.enabled Enable init container that changes the owner and group of the persistent volume false
volumePermissions.image.registry Init container volume-permissions image registry docker.io
volumePermissions.image.repository Init container volume-permissions image repository bitnami/bitnami-shell
volumePermissions.image.tag Init container volume-permissions image tag (immutable tags are recommended)
volumePermissions.image.digest Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
volumePermissions.image.pullPolicy Init container volume-permissions image pull policy IfNotPresent
volumePermissions.image.pullSecrets Init container volume-permissions image pull secrets []
volumePermissions.resources.limits Init container volume-permissions resource limits {}
volumePermissions.resources.requests Init container volume-permissions resource requests {}
volumePermissions.containerSecurityContext.enabled Enabled init container Security Context true
volumePermissions.containerSecurityContext.runAsUser User ID for the init container 0

Metrics parameters

Name Description Value
metrics.enabled Enable Prometheus to access ZooKeeper metrics endpoint false
metrics.containerPort ZooKeeper Prometheus Exporter container port 9141
metrics.service.type ZooKeeper Prometheus Exporter service type ClusterIP
metrics.service.port ZooKeeper Prometheus Exporter service port 9141
metrics.service.annotations Annotations for Prometheus to auto-discover the metrics endpoint {}
metrics.serviceMonitor.enabled Create ServiceMonitor Resource for scraping metrics using Prometheus Operator false
metrics.serviceMonitor.namespace Namespace for the ServiceMonitor Resource (defaults to the Release Namespace) ""
metrics.serviceMonitor.interval Interval at which metrics should be scraped. ""
metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended ""
metrics.serviceMonitor.additionalLabels Additional labels that can be used so ServiceMonitor will be discovered by Prometheus {}
metrics.serviceMonitor.selector Prometheus instance selector labels {}
metrics.serviceMonitor.relabelings RelabelConfigs to apply to samples before scraping []
metrics.serviceMonitor.metricRelabelings MetricRelabelConfigs to apply to samples before ingestion []
metrics.serviceMonitor.honorLabels Specify honorLabels parameter to add the scrape endpoint false
metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in prometheus. ""
metrics.prometheusRule.enabled Create a PrometheusRule for Prometheus Operator false
metrics.prometheusRule.namespace Namespace for the PrometheusRule Resource (defaults to the Release Namespace) ""
metrics.prometheusRule.additionalLabels Additional labels that can be used so PrometheusRule will be discovered by Prometheus {}
metrics.prometheusRule.rules PrometheusRule definitions []

TLS/SSL parameters

Name Description Value
tls.client.enabled Enable TLS for client connections false
tls.client.auth SSL Client auth. Can be "none", "want" or "need". none
tls.client.autoGenerated Generate automatically self-signed TLS certificates for ZooKeeper client communications false
tls.client.existingSecret Name of the existing secret containing the TLS certificates for ZooKeeper client communications ""
tls.client.existingSecretKeystoreKey The secret key from the tls.client.existingSecret containing the Keystore. ""
tls.client.existingSecretTruststoreKey The secret key from the tls.client.existingSecret containing the Truststore. ""
tls.client.keystorePath Location of the KeyStore file used for Client connections /opt/bitnami/zookeeper/config/certs/client/zookeeper.keystore.jks
tls.client.truststorePath Location of the TrustStore file used for Client connections /opt/bitnami/zookeeper/config/certs/client/zookeeper.truststore.jks
tls.client.passwordsSecretName Existing secret containing Keystore and truststore passwords ""
tls.client.passwordsSecretKeystoreKey The secret key from the tls.client.passwordsSecretName containing the password for the Keystore. ""
tls.client.passwordsSecretTruststoreKey The secret key from the tls.client.passwordsSecretName containing the password for the Truststore. ""
tls.client.keystorePassword Password to access KeyStore if needed ""
tls.client.truststorePassword Password to access TrustStore if needed ""
tls.quorum.enabled Enable TLS for quorum protocol false
tls.quorum.auth SSL Quorum Client auth. Can be "none", "want" or "need". none
tls.quorum.autoGenerated Create self-signed TLS certificates. Currently only supports PEM certificates. false
tls.quorum.existingSecret Name of the existing secret containing the TLS certificates for ZooKeeper quorum protocol ""
tls.quorum.existingSecretKeystoreKey The secret key from the tls.quorum.existingSecret containing the Keystore. ""
tls.quorum.existingSecretTruststoreKey The secret key from the tls.quorum.existingSecret containing the Truststore. ""
tls.quorum.keystorePath Location of the KeyStore file used for Quorum protocol /opt/bitnami/zookeeper/config/certs/quorum/zookeeper.keystore.jks
tls.quorum.truststorePath Location of the TrustStore file used for Quorum protocol /opt/bitnami/zookeeper/config/certs/quorum/zookeeper.truststore.jks
tls.quorum.passwordsSecretName Existing secret containing Keystore and truststore passwords ""
tls.quorum.passwordsSecretKeystoreKey The secret key from the tls.quorum.passwordsSecretName containing the password for the Keystore. ""
tls.quorum.passwordsSecretTruststoreKey The secret key from the tls.quorum.passwordsSecretName containing the password for the Truststore. ""
tls.quorum.keystorePassword Password to access KeyStore if needed ""
tls.quorum.truststorePassword Password to access TrustStore if needed ""
tls.resources.limits The resources limits for the TLS init container {}
tls.resources.requests The requested resources for the TLS init container {}
check-circle-line exclamation-circle-line close-line
Scroll to top icon