Skip to content

Commit 001bb39

Browse files
author
Felix Hennig
committed
Formatting
1 parent 3c460d4 commit 001bb39

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

docs/modules/zookeeper/pages/getting_started/first_steps.adoc

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Now that the operator is installed it is time to deploy a ZooKeeper cluster and
44

55
== Deploy ZooKeeper
66

7-
The ZooKeeper cluster is deployed with a very simple resource definition. Create a file called `zookeeper.yaml`:
7+
The ZooKeeper cluster is deployed with a very simple resource definition.
8+
Create a file called `zookeeper.yaml`:
89

910
[source,yaml]
1011
include::example$getting_started/code/zookeeper.yaml[]
@@ -13,12 +14,15 @@ and apply it:
1314
[source,bash]
1415
include::example$getting_started/code/getting_started.sh[tag=install-zookeeper]
1516

16-
The operator will create a ZooKeeper cluster with two replicas. Use kubectl to observe the status of the cluster:
17+
The operator will create a ZooKeeper cluster with two replicas.
18+
Use kubectl to observe the status of the cluster:
1719

1820
[source,bash]
1921
include::example$getting_started/code/getting_started.sh[tag=watch-zookeeper-rollout]
2022

21-
The Operator deploys readiness probes to make sure the replicas are ready and established a quorum. Only then will the StatefulSet actually be marked as `Ready`. You will see
23+
The Operator deploys readiness probes to make sure the replicas are ready and established a quorum.
24+
Only then will the StatefulSet actually be marked as `Ready`.
25+
You will see
2226

2327
----
2428
partitioned roll out complete: 2 new pods have been updated...
@@ -28,12 +32,15 @@ The ZooKeeper cluster is now ready.
2832

2933
== Deploy a ZNode
3034

31-
ZooKeeper manages its data in a hierarchical node system. You can look at the nodes using the zkCli tool. It is included inside the Stackable ZooKeeper container, and you can invoke it using `kubectl run`:
35+
ZooKeeper manages its data in a hierarchical node system.
36+
You can look at the nodes using the zkCli tool.
37+
It is included inside the Stackable ZooKeeper container, and you can invoke it using `kubectl run`:
3238

3339
[source,bash]
3440
include::example$getting_started/code/getting_started.sh[tag=zkcli-ls]
3541

36-
NOTE: You might wonder why the logs are used instead of the output from `kubectl run`. This is because `kubectl run` sometimes loses lines of the output, a link:https://github.com/kubernetes/kubernetes/issues/27264[known issue].
42+
NOTE: You might wonder why the logs are used instead of the output from `kubectl run`.
43+
This is because `kubectl run` sometimes loses lines of the output, a link:https://github.com/kubernetes/kubernetes/issues/27264[known issue].
3744

3845
Among the log output you will see the current list of nodes in the root directory `/`:
3946

@@ -45,7 +52,8 @@ Among the log output you will see the current list of nodes in the root director
4552
The `zookeeper` node contains ZooKeeper configuration data.
4653

4754
It is useful to use different nodes for different applications using ZooKeeper, and the Stackable Operator uses xref:znodes.adoc[ZNodes] for this.
48-
ZNodes are created with manifest files of the kind `ZookeeperZnode`. Create a file called `znode.yaml` with the following contents:
55+
ZNodes are created with manifest files of the kind `ZookeeperZnode`.
56+
Create a file called `znode.yaml` with the following contents:
4957

5058
[source,yaml]
5159
include::example$getting_started/code/znode.yaml[]
@@ -68,7 +76,8 @@ and the ZNode has appeared in the output:
6876

6977
== The discovery ConfigMap
7078

71-
The operator creates a ConfigMap with connection information that has the same name as the ZNode - in this case `simple-znode`. Have a look at it using
79+
The operator creates a ConfigMap with connection information that has the same name as the ZNode - in this case `simple-znode`.
80+
Have a look at it using
7281

7382
[source,bash]
7483
kubectl describe configmap simple-znode
@@ -87,11 +96,15 @@ ZOOKEEPER_HOSTS:
8796
simple-zk-server-default-0.simple-zk-server-default.default.svc.cluster.local:2282,simple-zk-server-default-1.simple-zk-server-default.default.svc.cluster.local:2282
8897
8998
The `ZOOKEEPER` entry contains a ZooKeeper connection string that you can use to connect to this specific ZNode.
90-
The `ZOOKEEPER_CHROOT` and `ZOOKEEPER_HOSTS` entries contain the node name and hosts list respectively. You can use these three entries mounted into a pod to connect to ZooKeeper at this specific ZNode and read/write in that ZNode directory.
99+
The `ZOOKEEPER_CHROOT` and `ZOOKEEPER_HOSTS` entries contain the node name and hosts list respectively.
100+
You can use these three entries mounted into a pod to connect to ZooKeeper at this specific ZNode and read/write in that ZNode directory.
91101
92102
93-
Great! This step concludes the Getting started guide. You have installed the ZooKeeper Operator and its dependencies and set up your first ZooKeeper cluster as well as your first ZNode.
103+
Great!
104+
This step concludes the Getting started guide.
105+
You have installed the ZooKeeper Operator and its dependencies and set up your first ZooKeeper cluster as well as your first ZNode.
94106
95107
== What's next
96108
97-
Have a look at the xref:usage_guide/index.adoc[] to learn more about configuration options for your ZooKeeper cluster like setting up encryption or authentication. You can also have a look at the xref:znodes.adoc[] page to learn more about ZNodes.
109+
Have a look at the xref:usage_guide/index.adoc[] to learn more about configuration options for your ZooKeeper cluster like setting up encryption or authentication.
110+
You can also have a look at the xref:znodes.adoc[] page to learn more about ZNodes.

0 commit comments

Comments
 (0)