Skip to content

Commit 2f589dc

Browse files
TechassiTechassi
committed
Various small adjustments
1 parent 21ac3ea commit 2f589dc

File tree

4 files changed

+40
-30
lines changed

4 files changed

+40
-30
lines changed

‎modules/ROOT/pages/getting_started.adoc

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ One of the best ways of getting started with a new platform is to try it out. An
44

55
== About this guide
66

7-
Firstly, let#s cover whether this *Getting Started* guide is right for you. This is intended as a learning tool to discover more about Stackable, its deployment and architecture.
7+
Firstly, let's cover whether this *Getting Started* guide is right for you. This is intended as a learning tool to discover more about Stackable, its deployment and architecture.
88

99
* If you want to build a production cluster then this is not for you. This tutorial is to familiarize you with the Stackable architecture and is not a guide for building robust clusters.
1010
* This is intended for use in a private network or lab; it doesn't enable many security features such as authentication or encryption and should not be directly connected to the Internet. Be careful if you're deploying in the cloud as your instances may default to using public IPs.
@@ -15,7 +15,7 @@ Stackable is based on Kubernetes and uses this as the control plane to manage cl
1515

1616
== Installing Kubernetes and kubectl
1717

18-
Stackable’s control plane is built around Kubernetes. Follow the xref:kubernetes.adoc#local-installation[instructions] on how to set up a local Kubernetes instance if you do not have access to a cluster and install kubectl.
18+
Stackable's control plane is built around Kubernetes. Follow the xref:kubernetes.adoc#local-installation[instructions] on how to set up a local Kubernetes instance if you do not have access to a cluster and install kubectl.
1919

2020
If you already have kubectl installed, and have access to a Kubernetes cluster, you can skip this step.
2121

@@ -26,9 +26,10 @@ If you already have kubectl installed, and have access to a Kubernetes cluster,
2626
Install the Stackable command line utility xref:management:stackablectl:index.adoc[stackablectl] by following the installation steps for your platform on the xref:management:stackablectl:installation.adoc[installation] page.
2727

2828
=== Installing Stackable Operators
29+
2930
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.
3031

31-
Stackable operators can be installed using stackablectl. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 23.7 release.
32+
Stackable operators can be installed using `stackablectl`. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 23.7 release.
3233

3334
[source,bash]
3435
----
@@ -61,13 +62,21 @@ helm install nifi-operator stackable-stable/nifi-operator --version=23.7
6162

6263
You can check which operators are installed using `stackablectl operator installed`:
6364

64-
----
65-
OPERATOR VERSION NAMESPACE STATUS LAST UPDATED
66-
commons 23.7.0 default deployed 2023-07-27 09:41:05.769685041 +0200 CEST
67-
kafka 23.7.0 default deployed 2023-07-27 09:41:27.685845379 +0200 CEST
68-
nifi 23.7.0 default deployed 2023-07-27 09:41:40.928558978 +0200 CEST
69-
secret 23.7.0 default deployed 2023-07-27 09:41:51.820834174 +0200 CEST
70-
zookeeper 23.7.0 default deployed 2023-07-27 09:41:54.972145417 +0200 CEST
65+
[source,console]
66+
----
67+
┌────────────────────┬─────────┬─────────────────────┬──────────┬──────────────────────────────────────────┐
68+
│ OPERATOR ┆ VERSION ┆ NAMESPACE ┆ STATUS ┆ LAST UPDATED │
69+
╞════════════════════╪═════════╪═════════════════════╪══════════╪══════════════════════════════════════════╡
70+
│ commons-operator ┆ 23.7.0 ┆ stackable-operators ┆ deployed ┆ 2023-09-26 14:59:10.447836367 +0200 CEST │
71+
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
72+
│ kafka-operator ┆ 23.7.0 ┆ stackable-operators ┆ deployed ┆ 2023-09-26 14:59:25.162058457 +0200 CEST │
73+
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
74+
│ nifi-operator ┆ 23.7.0 ┆ stackable-operators ┆ deployed ┆ 2023-09-26 14:59:35.881227443 +0200 CEST │
75+
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
76+
│ secret-operator ┆ 23.7.0 ┆ stackable-operators ┆ deployed ┆ 2023-09-26 14:59:44.51273442 +0200 CEST │
77+
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
78+
│ zookeeper-operator ┆ 23.7.0 ┆ stackable-operators ┆ deployed ┆ 2023-09-26 14:59:58.196949027 +0200 CEST │
79+
└────────────────────┴─────────┴─────────────────────┴──────────┴──────────────────────────────────────────┘
7180
----
7281

7382
== Deploying Stackable Services

‎modules/ROOT/pages/product-information.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ requires Helm version 3 or above.
6464

6565

6666
[#stackablectl-installation]
67-
=== stackablectl
67+
==== stackablectl
6868

69-
stackablectl is available for download, pre-built binaries are available on GitHub. The download link and installation
69+
`stackablectl` is available for download, pre-built binaries are available on GitHub. The download link and installation
7070
steps are provided in the xref:management:stackablectl:installation.adoc[installation].
7171

7272
== System requirements

‎modules/ROOT/pages/quickstart.adoc

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Superset:
4343

4444
[source,console]
4545
----
46-
./stackablectl demo install trino-taxi-data
46+
stackablectl demo install trino-taxi-data
4747
----
4848

4949
TIP: Learn more about this demo in the demo docs: xref:demos:trino-taxi-data.adoc[]
@@ -54,28 +54,29 @@ To list the installed installed Stackable services run the following command:
5454

5555
[source,console]
5656
----
57-
./stackablectl stacklet list
57+
stackablectl stacklet list
5858
----
5959

6060
It will output something like:
6161

6262
[source]
6363
----
64-
PRODUCT NAME NAMESPACE ENDPOINTS
65-
66-
hive hive default hive 172.18.0.5:30298
67-
metrics 172.18.0.5:31633
68-
69-
opa opa default http http://172.18.0.5:30316
70-
71-
superset superset default external-superset http://172.18.0.4:32295
72-
73-
trino trino default coordinator-http http://172.18.0.3:30167
74-
coordinator-metrics 172.18.0.3:31818
75-
coordinator-https https://172.18.0.3:3014
76-
77-
minio minio-trino default http http://172.18.0.3:31062
78-
console-http http://172.18.0.3:30503
64+
┌──────────┬───────────────┬───────────┬──────────────────────────────────────────────┬─────────────────────────────────┐
65+
│ PRODUCT ┆ NAME ┆ NAMESPACE ┆ ENDPOINTS ┆ CONDITIONS │
66+
╞══════════╪═══════════════╪═══════════╪══════════════════════════════════════════════╪═════════════════════════════════╡
67+
│ hive ┆ hive ┆ default ┆ ┆ Available, Reconciling, Running │
68+
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
69+
│ opa ┆ opa ┆ default ┆ ┆ Available, Reconciling, Running │
70+
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
71+
│ superset ┆ superset ┆ default ┆ external-superset http://172.18.0.3:31974 ┆ Available, Reconciling, Running │
72+
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
73+
│ trino ┆ trino ┆ default ┆ coordinator-metrics 172.18.0.3:30788 ┆ Available, Reconciling, Running │
74+
│ ┆ ┆ ┆ coordinator-https https://172.18.0.3:31010 ┆ │
75+
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
76+
│ minio ┆ minio-console ┆ default ┆ http http://172.18.0.3:32650 ┆ │
77+
└──────────┴───────────────┴───────────┴──────────────────────────────────────────────┴─────────────────────────────────┘
78+
79+
Use "stackablectl stacklet credentials [OPTIONS] <PRODUCT_NAME> <STACKLET_NAME>" to display credentials for deployed stacklets.
7980
----
8081

8182
To connect to Superset, open the listed endpoint in your browser and log in with the username `admin` and the password

‎modules/contributor/pages/adr/ADR021-stackablectl_stacks_initial_version.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ By defining our own, thin, abstraction layer we can isolate our users from the c
5858
We could do nothing right now and instead use the _create_test_cluster.py_ script as our entry point for the initial release.
5959

6060
* Good, this gives us time to design a fully thought out solution before implementing something
61-
* Bad, _create_test_cluster.py_ doesn't feel very polished and we do want to introducet _stackablectl_ to the world as our tool of choice
61+
* Bad, _create_test_cluster.py_ doesn't feel very polished and we do want to introduce _stackablectl_ to the world as our tool of choice
6262

6363
=== Implement basic definition of stacks
6464

0 commit comments

Comments
 (0)