Skip to content

Commit

Permalink
docs: update details
Browse files Browse the repository at this point in the history
  • Loading branch information
maxsxu committed Feb 19, 2022
1 parent 77b5bdb commit 0c10d2e
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ A simple Zookeeper Operator, which is responsible for operating zookeeper cluste

What we have?

- [ ] Deploy a zookeeper cluster quickly
- [ ] Zookeeper configurations load
- [ ] Expose zookeeper service to user
- [ ] Zookeeper status from `zk-cli stat`
- [x] Deploy a zookeeper cluster quickly
- [x] Zookeeper configurations load
- [x] Expose zookeeper service to user
- [x] Zookeeper cluster status synchronization

What not provided?

- [x] Zookeeper configurations reload
- [x] Webhook
- [ ] Zookeeper configurations reload
- [ ] Webhook

## Installation
1. Deploy the CRD
Expand All @@ -31,10 +31,10 @@ kubectl create -f zk-controller.yaml
1. Create a CR named `zk-cr.yaml` with below contents to setup a 3-node zookeeper cluster

```yaml
apiVersion: "zookeeper.atmax.io/v1alpha1"
apiVersion: "zookeepercluster.atmax.io/v1alpha1"
kind: "ZookeeperCluster"
metadata:
name: "zookeeper"
name: "zookeepercluster-sample"
spec:
replicas: 3
config:
Expand All @@ -57,9 +57,9 @@ NAME READY ENDPOINT
zookeepercluster-sample 3 10.80.31.21:16146
```

Then user can access the Zookeeper cluster via `10.0.0.1:2181`
Then user can access the Zookeeper cluster via `10.80.31.21:16146`

We can also get more details about this cluster via `kubectl get zookeepercluster zookeepercluster-sample -o yaml`
More details about this cluster can be found via `kubectl get zookeepercluster zookeepercluster-sample -o yaml`

```yaml
status:
Expand Down

0 comments on commit 0c10d2e

Please sign in to comment.