You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=issues) for Product and Platform release notes
22
-
- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=pullrequests) for Product and Platform release notes
19
+
## Release note compilation tasks
20
+
21
+
-[ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYY.M.X%2Cscheduled-for%2FYY.M.X&type=issues) for Product and Platform release notes
22
+
-[ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYY.M.X%2Cscheduled-for%2FYY.M.X&type=pullrequests) for Product and Platform release notes
23
23
-[ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.M.X%22&type=code) in case release notes were missed
24
24
-[ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights
25
25
-[ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release
@@ -28,15 +28,13 @@
28
28
-[ ] Upgrade guide: List removed product versions (if there are any)
29
29
-[ ] Upgrade guide: List removed operators (if there are any)
30
30
-[ ] Upgrade guide: List supported Kubernetes versions
31
-
```
32
31
33
32
Each of the following tasks focuses on a specific goal and should be done once the items above have been completed.
34
33
35
-
```[tasklist]
36
-
#### Release note review tasks
34
+
## Release note review tasks
35
+
37
36
-[ ] Check overall document structure
38
37
-[ ] Check spelling, grammar, and correct wording
39
38
-[ ] Check that internal links are xrefs
40
39
-[ ] Check that rendered links are valid
41
40
-[ ] Check that each sentence begins on a new line
Copy file name to clipboardExpand all lines: modules/ROOT/pages/getting-started.adoc
+40-26Lines changed: 40 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
:page-aliases: getting_started.adoc
3
3
:description: Learn how to set up and test a Stackable Data Platform with Apache ZooKeeper, Kafka, and NiFi using Kubernetes. Ideal for lab environments.
4
4
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.
6
7
7
8
== About this guide
8
9
@@ -13,7 +14,8 @@ Firstly, let's cover whether this *Getting Started* guide is right for you. This
13
14
14
15
== Overview
15
16
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.
17
19
18
20
== Installing Kubernetes and kubectl
19
21
@@ -30,32 +32,36 @@ Install the Stackable command line utility xref:management:stackablectl:index.ad
30
32
31
33
=== Installing Stackable Operators
32
34
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.
34
38
35
-
Stackable operators can be installed using `stackablectl`. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 25.3 release.
39
+
Stackable operators can be installed using `stackablectl`.
40
+
Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 25.7 release.
@@ -64,17 +70,18 @@ You can check which operators are installed using `stackablectl operator install
64
70
[source,console]
65
71
----
66
72
OPERATOR VERSION NAMESPACE STATUS LAST UPDATED
67
-
commons 25.3.0 default deployed 2024-11-30 17:58:32.916032854 +0100 CET
68
-
kafka 25.3.0 default deployed 2024-11-30 17:58:55.036115353 +0100 CET
69
-
listener 25.3.0 default deployed 2024-11-30 17:59:18.136775259 +0100 CET
70
-
nifi 25.3.0 default deployed 2024-11-30 17:59:51.927081648 +0100 CET
71
-
secret 25.3.0 default deployed 2024-11-30 18:00:05.060241771 +0100 CET
72
-
zookeeper 25.3.0 default deployed 2024-11-30 18:00:08.425686918 +0100 CET
73
+
commons 25.7.0 default deployed 2025-07-24 17:58:32.916032854 +0100 CET
74
+
kafka 25.7.0 default deployed 2025-07-24 17:58:55.036115353 +0100 CET
75
+
listener 25.7.0 default deployed 2025-07-24 17:59:18.136775259 +0100 CET
76
+
nifi 25.7.0 default deployed 2025-07-24 17:59:51.927081648 +0100 CET
77
+
secret 25.7.0 default deployed 2025-07-24 18:00:05.060241771 +0100 CET
78
+
zookeeper 25.7.0 default deployed 2025-07-24 18:00:08.425686918 +0100 CET
73
79
----
74
80
75
81
== Deploying Stackable Services
76
82
77
-
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.
78
85
79
86
=== Apache ZooKeeper
80
87
@@ -113,7 +120,8 @@ EOF
113
120
114
121
=== Apache Kafka
115
122
116
-
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.
117
125
118
126
[source,bash]
119
127
----
@@ -207,7 +215,8 @@ stringData:
207
215
EOF
208
216
----
209
217
210
-
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.
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.
231
241
232
242
== Testing your cluster
233
243
234
244
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.
235
245
236
246
=== Apache ZooKeeper
237
247
238
-
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.
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.
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:
264
277
265
278
[source,bash]
266
279
----
@@ -298,7 +311,8 @@ Browse to the address of your Kubernetes node on port `31931` e.g. https://172.1
298
311
299
312
image:nifi_login_screen.png[The Apache NiFi web interface login screen]
300
313
301
-
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.
0 commit comments