Skip to content

Commit 524a7c2

Browse files
authored
Add instructions for using stackablectl instead of Helm (#219)
* using stackablectl in the tutorial * use stackablectl in getting started and added notes for using Helm
1 parent 53be277 commit 524a7c2

File tree

2 files changed

+91
-26
lines changed

2 files changed

+91
-26
lines changed

modules/ROOT/pages/getting_started.adoc

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -74,30 +74,32 @@ CoreDNS is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/servi
7474
Metrics-server is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/https:metrics-server:/proxy
7575
----
7676

77-
=== Installing Helm
78-
Stackable uses https://helm.sh/[Helm] as the package manager for its Kubernetes operators. This greatly simplifies the deployment and management of Kubernetes operators and CRDs. The quickest way to install Helm is to run the following command:
77+
== Installing Stackable
78+
=== Install stackablectl
79+
80+
Install the Stackable command line utility xref:stackablectl::index.adoc[stackablectl] by following the installation steps for your platform on the xref:stackablectl::installation.adoc[installation] page.
81+
82+
=== Installing Stackable Operators
83+
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.
84+
85+
Stackable operators are installed using stackablectl. Run the following commands to install the latest operator versions of ZooKeeper, Kafka and NiFi.
7986

8087
[source,bash]
8188
----
82-
curl -sfL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | /bin/bash -
89+
stackablectl operator install zookeeper secret nifi kafka
8390
----
8491

85-
86-
== Installing Stackable
87-
=== Install Stackable Helm Repositories
88-
With Helm installed you can add the Stackable operator repo, where the helm charts to install Stackable operators can be found. There are development, test and a stable repositories available, we'll be using the stable repo in this guide.
92+
.Using Helm instead
93+
[%collapsible]
94+
====
95+
Add the stackable-stable Helm Chart repository:
8996
9097
[source,bash]
9198
----
9299
helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/
93100
----
94101
95-
=== Installing Stackable Operators
96-
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.
97-
98-
Stackable operators are installed using Helm charts. Run the following commands to install the operators for ZooKeeper, Kafka and NiFi using the repo configured earlier. The --devel flag will choose the latest available version; alternatively the --version flag can be used to deploy a specific version.
99-
100-
==== Install operators from the Stackable repository
102+
Install the operators:
101103
102104
[source,bash]
103105
----
@@ -106,15 +108,16 @@ helm install kafka-operator stackable-stable/kafka-operator --version=0.5.0
106108
helm install secret-operator stackable-stable/secret-operator --version=0.2.0
107109
helm install nifi-operator stackable-stable/nifi-operator --version=0.5.0
108110
----
111+
====
109112

110-
You can check which operators are installed using `helm list`:
113+
You can check which operators are installed using `stackablectl operator installed`:
111114

112115
----
113-
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
114-
kafka-operator default 1 2022-02-15 08:17:26.84659409 +0000 UTC deployed kafka-operator-0.5.0 0.5.0
115-
nifi-operator default 1 2022-02-15 08:17:37.93720808 +0000 UTC deployed nifi-operator-0.5.0 0.5.0
116-
secret-operator default 1 2022-02-15 08:17:32.700301793 +0000 UTC deployed secret-operator-0.2.0 0.2.0
117-
zookeeper-operatordefault 1 2022-02-15 08:17:17.893844595 +0000 UTC deployed zookeeper-operator-0.9.0 0.9.0
116+
OPERATOR VERSION NAMESPACE STATUS LAST UPDATED
117+
kafka 0.6.0-nightly default deployed 2022-06-16 13:51:05.661282811 +0200 CEST
118+
nifi 0.6.0-nightly default deployed 2022-06-20 16:22:45.985504689 +0200 CEST
119+
secret 0.5.0-nightly default deployed 2022-06-20 16:07:40.248027167 +0200 CEST
120+
zookeeper 0.10.0-nightly default deployed 2022-06-16 13:50:51.497813301 +0200 CEST
118121
----
119122

120123
== Deploying Stackable Services

modules/tutorials/pages/end-to-end_data_pipeline_example.adoc

Lines changed: 69 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,22 @@ You should make sure that you have everything you need:
1313

1414
* A running Kubernetes cluster
1515
* https://kubernetes.io/docs/tasks/tools/#kubectl[Kubectl] to interact with the cluster
16-
* https://helm.sh/[Helm] to deploy Operators and some dependencies
17-
* Shell utilities like `cat` and `curl`
18-
19-
Throughout the tutorial you will install Operators from the Stackable Helm repository using Helm. To easily install from the Stackable repository, add a link to it to your Helm repository list:
16+
* https://helm.sh/[Helm] to deploy third-party dependencies
17+
* xref:stackablectl::installation.adoc[stackablectl] to install and interact with Stackable operators
18+
+
19+
[NOTE]
20+
====
21+
While we recommend to use stackablectl, you can also install operators from the Helm Chart repository:
2022
2123
[source,bash]
24+
----
2225
helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/
26+
----
27+
28+
Instructions for installing via Helm are also provided throughout the tutorial.
29+
30+
====
31+
* Shell utilities like `cat` and `curl`
2332

2433
== Nifi and Kafka
2534

@@ -36,30 +45,66 @@ The xref:secret-operator::index.adoc[Secret Operator] is needed by the Stackable
3645
The necessary certificates and keys for this are provided by the Secret Operator to the NiFi Pods.
3746

3847
[source,bash]
48+
stackablectl operator install secret
49+
50+
.Using Helm instead
51+
[%collapsible]
52+
====
53+
[source,bash]
54+
----
3955
helm install secret-operator stackable-stable/secret-operator
56+
----
57+
====
4058

4159
==== ZooKeeper Operator
4260

4361
Apache NiFi and Apache Kafka both use Apache ZooKeeper as backing config storage, so the xref:zookeeper::index.adoc[Stackable Operator for Apache ZooKeeper] has to be installed in order to make sure that a ZooKeeper cluster can be rolled out.
4462
There is no need to install multiple ZooKeeper clusters, as NiFi, Kafka and Druid can share the same cluster via provisioning a ZNode per backed service.
4563

4664
[source,bash]
65+
stackablectl operator install zookeeper
66+
67+
.Using Helm instead
68+
[%collapsible]
69+
====
70+
[source,bash]
71+
----
4772
helm install zookeeper-operator stackable-stable/zookeeper-operator
73+
----
74+
====
4875

4976
==== Kafka Operator
5077

5178
NiFi publishes the individual records from the S3 data to Kafka.
5279

5380
[source,bash]
54-
helm install kafka-operator stackable-stable/kafka-operator
81+
stackablectl operator install kafka
82+
83+
.Using Helm instead
84+
[%collapsible]
85+
====
86+
[source,bash]
87+
----
88+
helm install zookeeper-operator stackable-stable/kafka-operator
89+
----
90+
====
5591

5692
==== NiFi Operator
5793

5894
NiFi is an ETL tool which will be used to model the dataflow of downloading and splitting files from S3.
5995
It will also be used to convert the file content from CSV to JSON.
6096

6197
[source,bash]
98+
stackablectl operator install nifi=0.6.0-nightly
99+
100+
.Using Helm instead
101+
[%collapsible]
102+
====
103+
[source,bash]
104+
----
62105
helm install --repo https://repo.stackable.tech/repository/helm-dev nifi-operator nifi-operator --version=0.6.0-nightly
106+
----
107+
====
63108

64109
=== Deploying Kafka and NiFi
65110

@@ -259,8 +304,16 @@ You will set up the Operator and some dependencies, provision a Druid cluster an
259304
Like the other Operators, the Druid Operator is easily installed with Helm:
260305

261306
[source,bash]
262-
helm install druid-operator stackable-stable/druid-operator
307+
stackablectl operator install druid
263308

309+
.Using Helm instead
310+
[%collapsible]
311+
====
312+
[source,bash]
313+
----
314+
helm install druid-operator stackable-stable/druid-operator
315+
----
316+
====
264317

265318
=== Set up dependencies
266319

@@ -508,7 +561,16 @@ To analyze the data in Druid, the steps below explain how you can connect a Supe
508561
As before, you need to install the Operator:
509562

510563
[source, bash]
511-
helm install superset-operator stackable-stable/superset-operator
564+
stackablectl operator install superset
565+
566+
.Using Helm instead
567+
[%collapsible]
568+
====
569+
[source,bash]
570+
----
571+
helm install druid-operator stackable-stable/superset-operator
572+
----
573+
====
512574

513575
=== Set up dependencies
514576

0 commit comments

Comments
 (0)