Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Nuance-XINFRA/zookeeper-operator

Kubernetes Operator for Apache Zookeeper
https://github.com/Nuance-XINFRA/zookeeper-operator

Last synced: about 1 month ago
JSON representation

Kubernetes Operator for Apache Zookeeper

Host: GitHub
URL: https://github.com/Nuance-XINFRA/zookeeper-operator
Owner: Nuance-XINFRA
License: apache-2.0
Created: 2018-04-27T13:11:07.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2018-07-16T13:19:22.000Z (almost 6 years ago)
Last Synced: 2024-05-13T05:33:18.799Z (about 2 months ago)
Language: Go
Size: 53.7 KB
Stars: 18
Watchers: 7
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-operators - Nuance-Mobility/zookeeper-operator

README

# Zookeeper operator

### Project status: alpha

## Overview

The Zookeeper operator manages Zookeeper clusters deployed to [Kubernetes][k8s-home] and automates tasks related to operating a Zookeeper cluster.

- [Create and destroy](#create-and-destroy-a-zookeeper-cluster)
- [Resize](#resize-a-zookeeper-cluster)
- [Recover a member](#member-recovery)
- [Rolling upgrade](#upgrade-a-zookeeper-cluster)

## Requirements

- Kubernetes 1.7+
- Zookeeper 3.5.3-beta+

## Install Zookeeper operator

Create a deployment for Zookeeper operator:

```bash
$ kubectl create -f example/deployment.yaml
```

Zookeeper operator will automatically create a Kubernetes Custom Resource Definition (CRD):

```bash
$ kubectl get customresourcedefinitions
NAME AGE
zookeeperclusters.zookeeper.database.apache.com 1m
```

## Uninstall Zookeeper operator

Note that the Zookeeper clusters managed by Zookeeper operator will **NOT** be deleted even if the operator is uninstalled.

This is an intentional design to prevent accidental operator failure from killing all the Zookeeper clusters.

To delete all clusters, delete all cluster CR objects before uninstalling the operator.

Clean up Zookeeper operator:

```bash
kubectl delete -f example/deployment.yaml
```

## Create and destroy a Zookeeper cluster

```bash
$ kubectl create -f example/example-zookeeper-cluster.yaml
```

A 3 member Zookeeper cluster will be created.

```bash
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
example-zookeeper-cluster-1 1/1 Running 0 1m
example-zookeeper-cluster-2 1/1 Running 0 1m
example-zookeeper-cluster-3 1/1 Running 0 1m
```

Destroy Zookeeper cluster:

```bash
$ kubectl delete -f example/example-zookeeper-cluster.yaml
```

## Resize a Zookeeper cluster

Create a Zookeeper cluster:

```
$ kubectl apply -f example/example-zookeeper-cluster.yaml
```

In `example/example-zookeeper-cluster.yaml` the initial cluster size is 3.
Modify the file and change `size` from 3 to 5.

```
$ cat example/example-zookeeper-cluster.yaml
apiVersion: "zookeeper.database.apache.com/v1alpha1"
kind: "ZookeeperCluster"
metadata:
name: "example-zookeeper-cluster"
spec:
size: 5
version: "3.5.3-beta"
```

Apply the size change to the cluster CR:
```
$ kubectl apply -f example/example-zookeeper-cluster.yaml
```
The Zookeeper cluster will scale to 5 members (5 pods):
```
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
example-zookeeper-cluster-1 1/1 Running 0 1m
example-zookeeper-cluster-2 1/1 Running 0 1m
example-zookeeper-cluster-3 1/1 Running 0 1m
example-zookeeper-cluster-4 1/1 Running 0 1m
example-zookeeper-cluster-5 1/1 Running 0 1m
```

Similarly we can decrease the size of cluster from 5 back to 3 by changing the size field again and reapplying the change.

We should see that Zookeeper cluster will eventually reduce to 3 pods:

```
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
example-zookeeper-cluster-2 1/1 Running 0 1m
example-zookeeper-cluster-3 1/1 Running 0 1m
example-zookeeper-cluster-5 1/1 Running 0 1m
```

## Member recovery

If the minority of Zookeeper members crash, the Zookeeper operator will automatically recover the failure.
Let's walk through in the following steps.

Create a Zookeeper cluster:

```
$ kubectl create -f example/example-zookeeper-cluster.yaml
```

Wait until all three members are up. Simulate a member failure by deleting a pod:

```bash
$ kubectl delete pod example-zookeeper-cluster-1 --now
```

The Zookeeper operator will recover the failure by creating a new pod `example-zookeeper-cluster-4`:

```bash
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
example-zookeeper-cluster-2 1/1 Running 0 1m
example-zookeeper-cluster-3 1/1 Running 0 1m
example-zookeeper-cluster-4 1/1 Running 0 1m
```

Destroy Zookeeper cluster:
```bash
$ kubectl delete -f example/example-zookeeper-cluster.yaml
```

## Zookeeper operator recovery

If the Zookeeper operator restarts, it can recover its previous state.
Let's walk through in the following steps.

```
$ kubectl create -f example/example-zookeeper-cluster.yaml
```

Wait until all three members are up. Then

```bash
$ kubectl delete -f example/deployment.yaml
deployment "zookeeper-operator" deleted

$ kubectl delete pod example-zookeeper-cluster-1 --now
pod "example-zookeeper-cluster-1" deleted
```

Then restart the Zookeeper operator. It should recover itself and the Zookeeper clusters it manages.

```bash
$ kubectl create -f example/deployment.yaml
deployment "zookeeper-operator" created

$ kubectl get pods
NAME READY STATUS RESTARTS AGE
example-zookeeper-cluster-2 1/1 Running 0 1m
example-zookeeper-cluster-3 1/1 Running 0 1m
example-zookeeper-cluster-4 1/1 Running 0 1m
```

## Limitations

- The Zookeeper operator only manages the Zookeeper cluster created in the same namespace. Users need to create multiple operators in different namespaces to manage Zookeeper clusters in different namespaces.
- Persistent volumes not currently supported.
- If quorum is lost in the cluster reconfiguration breaks.
- Cluster downsizing is naive, can kill the quorum leader causing re-election.
- Cluster upgrade is naive, may prematurely upgrade the quorum leader causing re-election

[k8s-home]: http://kubernetes.io