incubator/zookeeper
This helm chart provides an implementation of the ZooKeeper StatefulSet found in Kubernetes Contrib Zookeeper StatefulSet.
Prerequisites
- Kubernetes 1.10+
- PersistentVolume support on the underlying infrastructure
- A dynamic provisioner for the PersistentVolumes
- A familiarity with Apache ZooKeeper 3.5.x
Chart Components
This chart will do the following:
- Create a fixed size ZooKeeper ensemble using a StatefulSet.
- Create a PodDisruptionBudget so kubectl drain will respect the Quorum size of the ensemble.
- Create a Headless Service to control the domain of the ZooKeeper ensemble.
- Create a Service configured to connect to the available ZooKeeper instance on the configured client port.
- Optionally apply a Pod Anti-Affinity to spread the ZooKeeper ensemble across nodes.
- Optionally start JMX Exporter and Zookeeper Exporter containers inside Zookeeper pods.
- Optionally create a job which creates Zookeeper chroots (e.g.
/kafka1). - Optionally create a Prometheus ServiceMonitor for each enabled exporter container
Installing the Chart
You can install the chart with the release name zookeeper as below.
$ helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator
$ helm install --name zookeeper incubator/zookeeper
If you do not specify a name, helm will select a name for you.
Installed Components
You can use kubectl get to view all of the installed components.
$ kubectl get all -l app=zookeeper
NAME: zookeeper
LAST DEPLOYED: Wed Apr 11 17:09:48 2018
NAMESPACE: default
STATUS: DEPLOYED
RESOURCES:
==> v1beta1/PodDisruptionBudget
NAME MIN AVAILABLE MAX UNAVAILABLE ALLOWED DISRUPTIONS AGE
zookeeper N/A 1 1 2m
==> v1/Service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
zookeeper-headless ClusterIP None <none> 2181/TCP,3888/TCP,2888/TCP 2m
zookeeper ClusterIP 10.98.179.165 <none> 2181/TCP 2m
==> v1beta1/StatefulSet
NAME DESIRED CURRENT AGE
zookeeper 3 3 2m
==> monitoring.coreos.com/v1/ServiceMonitor
NAME AGE
zookeeper 2m
zookeeper-exporter 2m
statefulsets/zookeeperis the StatefulSet created by the chart.po/zookeeper-<0|1|2>are the Pods created by the StatefulSet. Each Pod has a single container running a ZooKeeper server.svc/zookeeper-headlessis the Headless Service used to control the network domain of the ZooKeeper ensemble.svc/zookeeperis a Service that can be used by clients to connect to an available ZooKeeper server.servicemonitor/zookeeperis a Prometheus ServiceMonitor which scrapes the jmx-exporter metrics endpointservicemonitor/zookeeper-exporteris a Prometheus ServiceMonitor which scrapes the zookeeper-exporter metrics endpoint
Configuration
You can specify each parameter using the --set key=value[,key=value] argument to helm install.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
$ helm install --name my-release -f values.yaml incubator/zookeeper
Default Values
- You can find all user-configurable settings, their defaults and commentary about them in values.yaml.
Deep Dive
Image Details
The image used for this chart is based on Alpine 3.9.0.
JVM Details
The Java Virtual Machine used for this chart is the OpenJDK JVM 8u192 JRE (headless).
ZooKeeper Details
The chart defaults to ZooKeeper 3.5 (latest released version).
Failover
You can test failover by killing the leader. Insert a key:
$ kubectl exec zookeeper-0 -- bin/zkCli.sh create /foo bar;
$ kubectl exec zookeeper-2 -- bin/zkCli.sh get /foo;
Watch existing members:
$ kubectl run --attach bbox --image=busybox --restart=Never -- sh -c 'while true; do for i in 0 1 2; do echo zk-${i} $(echo stats | nc <pod-name>-${i}.<headless-service-name>:2181 | grep Mode); sleep 1; done; done';
zk-2 Mode: follower
zk-0 Mode: follower
zk-1 Mode: leader
zk-2 Mode: follower
Delete Pods and wait for the StatefulSet controller to bring them back up:
$ kubectl delete po -l app=zookeeper
$ kubectl get po --watch-only
NAME READY STATUS RESTARTS AGE
zookeeper-0 0/1 Running 0 35s
zookeeper-0 1/1 Running 0 50s
zookeeper-1 0/1 Pending 0 0s
zookeeper-1 0/1 Pending 0 0s
zookeeper-1 0/1 ContainerCreating 0 0s
zookeeper-1 0/1 Running 0 19s
zookeeper-1 1/1 Running 0 40s
zookeeper-2 0/1 Pending 0 0s
zookeeper-2 0/1 Pending 0 0s
zookeeper-2 0/1 ContainerCreating 0 0s
zookeeper-2 0/1 Running 0 19s
zookeeper-2 1/1 Running 0 41s
Check the previously inserted key:
$ kubectl exec zookeeper-1 -- bin/zkCli.sh get /foo
ionid = 0x354887858e80035, negotiated timeout = 30000
WATCHER::
WatchedEvent state:SyncConnected type:None path:null
bar
Scaling
ZooKeeper can not be safely scaled in versions prior to 3.5.x
Limitations
- Only supports storage options that have backends for persistent volume claims.