Skip to content

Commit

Permalink
README.md fixes (#130)
Browse files Browse the repository at this point in the history
* Close code-block in GKE notes

Signed-off-by: Paul "Hampy" Hampson <[email protected]>

* Put the ASCII diagram in a code block

Signed-off-by: Paul "Hampy" Hampson <[email protected]>

* Fix markdown of Zookeeper YAML Exporter notes

Signed-off-by: Paul "Hampy" Hampson <[email protected]>
  • Loading branch information
TBBle authored Feb 24, 2020
1 parent e72c852 commit 8c1b44b
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,12 +235,13 @@ On GKE, the following command must be run before installing the operator, replac

```
$ kubectl create clusterrolebinding your-user-cluster-admin-binding --clusterrole=cluster-admin [email protected]
```

#### Zookeeper YAML Exporter

Zookeeper Exporter is a binary which is used to generate YAML file for all the secondary resources which Zookeeper Operator deploys to the Kubernetes Cluster. It takes ZookeeperCluster resource YAML file as input and generates bunch of secondary resources YAML files. The generated output look like the following:

```
>tree ZookeeperCluster/
ZookeeperCluster/
├── client
Expand All @@ -253,12 +254,14 @@ ZookeeperCluster/
│   └── PodDisruptionBudget.yaml
└── zk
└── StatefulSet.yaml
```

##### How to build Zookeeper Operator

#How to build Zookeeper Operator
When you build Operator, the Exporter is built along with it.
make build-go - will build both Operator as well as Exporter.
`make build-go` - will build both Operator as well as Exporter.

##### How to use exporter

#How to use exporter
Just run zookeeper-exporter binary with -help option. It will guide you to input ZookeeperCluster YAML file. There are couple of more options to specify.
Example: ./zookeeper-exporter -i ./ZookeeperCluster.yaml -o .
Example: `./zookeeper-exporter -i ./ZookeeperCluster.yaml -o .`

0 comments on commit 8c1b44b

Please sign in to comment.