Skip to content

Commit db24d23

Browse files
committed
chore: Put sentences on single lines on getting-started page
1 parent ee874b0 commit db24d23

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

modules/ROOT/pages/getting-started.adoc

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
:page-aliases: getting_started.adoc
33
:description: Learn how to set up and test a Stackable Data Platform with Apache ZooKeeper, Kafka, and NiFi using Kubernetes. Ideal for lab environments.
44

5-
One of the best ways of getting started with a new platform is to try it out. Any big data platform has a lot of moving parts and getting some hands on keyboard time with it helps reinforce learning.
5+
One of the best ways of getting started with a new platform is to try it out.
6+
Any big data platform has a lot of moving parts and getting some hands on keyboard time with it helps reinforce learning.
67

78
== About this guide
89

@@ -13,7 +14,8 @@ Firstly, let's cover whether this *Getting Started* guide is right for you. This
1314

1415
== Overview
1516

16-
Stackable is based on Kubernetes and uses this as the control plane to manage clusters. In this guide we will build a simple cluster with 3 services; Apache ZooKeeper, Apache Kafka and Apache NiFi.
17+
Stackable is based on Kubernetes and uses this as the control plane to manage clusters.
18+
In this guide we will build a simple cluster with 3 services; Apache ZooKeeper, Apache Kafka and Apache NiFi.
1719

1820
== Installing Kubernetes and kubectl
1921

@@ -30,7 +32,9 @@ Install the Stackable command line utility xref:management:stackablectl:index.ad
3032

3133
=== Installing Stackable Operators
3234

33-
The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes. These can be installed on any node that has access to the Kubernetes control plane. In this example we will install them on the controller node.
35+
The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes.
36+
These can be installed on any node that has access to the Kubernetes control plane.
37+
In this example we will install them on the controller node.
3438

3539
Stackable operators can be installed using `stackablectl`.
3640
Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 25.7 release.
@@ -45,7 +49,8 @@ stackablectl release install -i commons -i secret -i listener -i zookeeper -i ka
4549
====
4650
NOTE: These examples assume Helm version 3. They will not work with Helm version 2.
4751
48-
`helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.
52+
`helm repo` subcommands are not supported for OCI registries.
53+
The operators are installed directly, without adding the Helm Chart repository first.
4954
5055
Install the operators:
5156
@@ -75,7 +80,8 @@ zookeeper 25.7.0 default deployed
7580

7681
== Deploying Stackable Services
7782

78-
At this point you've successfully deployed Kubernetes and the Stackable operators we need and are ready to deploy services to the cluster. To do this we provide service descriptions to Kubernetes for each of the services we wish to deploy.
83+
At this point you've successfully deployed Kubernetes and the Stackable operators we need and are ready to deploy services to the cluster.
84+
To do this we provide service descriptions to Kubernetes for each of the services we wish to deploy.
7985

8086
=== Apache ZooKeeper
8187

@@ -114,7 +120,8 @@ EOF
114120

115121
=== Apache Kafka
116122

117-
We will deploy an Apache Kafka broker that depends on the ZooKeeper service we just deployed. The zookeeperReference property below points to the namespace and name we gave to the ZooKeeper service deployed previously.
123+
We will deploy an Apache Kafka broker that depends on the ZooKeeper service we just deployed.
124+
The zookeeperReference property below points to the namespace and name we gave to the ZooKeeper service deployed previously.
118125

119126
[source,bash]
120127
----
@@ -208,7 +215,8 @@ stringData:
208215
EOF
209216
----
210217

211-
You can check the status of the services using `kubectl get pods`. This will retrieve the status of all pods running in the default namespace.
218+
You can check the status of the services using `kubectl get pods`.
219+
This will retrieve the status of all pods running in the default namespace.
212220

213221
----
214222
NAME READY STATUS RESTARTS AGE
@@ -228,22 +236,25 @@ simple-zk-server-primary-0 1/1 Running 0
228236
zookeeper-operator-deployment-7bcdcbb558-xc77h 1/1 Running 0 13m
229237
----
230238

231-
Since this is the first time that each of these services has been deployed to these nodes, it will take some time to download the software from the Stackable repository and deploy the services. Once all the pods are in the running state your cluster is ready to use.
239+
Since this is the first time that each of these services has been deployed to these nodes, it will take some time to download the software from the Stackable repository and deploy the services.
240+
Once all the pods are in the running state your cluster is ready to use.
232241

233242
== Testing your cluster
234243

235244
If all has gone well then you will have successfully deployed a Stackable cluster and used it to start three services that should now be ready for you.
236245

237246
=== Apache ZooKeeper
238247

239-
We can test ZooKeeper by running the ZooKeeper CLI shell. The easiest way to do this is to run the CLI shell on the pod that is running ZooKeeper.
248+
We can test ZooKeeper by running the ZooKeeper CLI shell.
249+
The easiest way to do this is to run the CLI shell on the pod that is running ZooKeeper.
240250

241251
[source,bash]
242252
----
243253
kubectl exec -i -t simple-zk-server-primary-0 -- bin/zkCli.sh
244254
----
245255

246-
The shell should connect automatically to the ZooKeeper server running on the pod. You can run the `ls /` command to see the list of znodes in the root path, which should include those created by Apache Kafka and Apache NiFi.
256+
The shell should connect automatically to the ZooKeeper server running on the pod.
257+
You can run the `ls /` command to see the list of znodes in the root path, which should include those created by Apache Kafka and Apache NiFi.
247258

248259
----
249260
[zk: localhost:2181(CONNECTED) 0] ls /
@@ -261,7 +272,8 @@ kubectl exec -i -t simple-kafka-broker-brokers-0 -c kafka -- \
261272
bin/kafka-topics.sh --bootstrap-server localhost:9092 --create --topic demo
262273
----
263274

264-
You should see the message, "Created topic demo." on the console. Now let's check to see if it was actually created:
275+
You should see the message, "Created topic demo." on the console.
276+
Now let's check to see if it was actually created:
265277

266278
[source,bash]
267279
----
@@ -299,7 +311,8 @@ Browse to the address of your Kubernetes node on port `31931` e.g. https://172.1
299311

300312
image:nifi_login_screen.png[The Apache NiFi web interface login screen]
301313

302-
If a password has not been specified for the admin user the Apache NiFi operator will automatically generate the admin user credentials with a random password and store it as a Kubernetes secret in order to provide some security out of the box. In the example above we have provided our own secret, but you can retrieve and confirm this password for the `admin` user with the following kubectl command.
314+
If a password has not been specified for the admin user the Apache NiFi operator will automatically generate the admin user credentials with a random password and store it as a Kubernetes secret in order to provide some security out of the box.
315+
In the example above we have provided our own secret, but you can retrieve and confirm this password for the `admin` user with the following kubectl command.
303316

304317
[source,bash]
305318
----

0 commit comments

Comments
 (0)