Skip to content

Commit f2d9075

Browse files
author
Felix Hennig
committed
Update installation instructions
1 parent bfb040e commit f2d9075

File tree

1 file changed

+37
-26
lines changed

1 file changed

+37
-26
lines changed
Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
= Installation
2-
3-
There are two ways to run the Stackable Commons Operator:
4-
5-
. Helm managed Docker container deployment on Kubernetes
6-
. Build from source
2+
:description: Install the Stackable Commons Operator with either stackablectl or Helm.
73

84
== Prerequisites
95

@@ -18,36 +14,51 @@ Resource sizing depends on cluster type(s), usage and scope, but as a starting p
1814
* 0.2 cores (e.g. i5 or similar)
1915
* 256MB RAM
2016

21-
== Helm
22-
Helm allows you to download and deploy Stackable operators on Kubernetes and is by far the easiest installation method.
23-
First ensure that you have installed the Stackable Operators Helm repository:
17+
== Installation
2418

25-
[source,console]
26-
----
27-
$ helm repo add stackable https://repo.stackable.tech/repository/helm-stable/
28-
----
19+
There are two ways to deploy the Commons operator into your Kubernetes cluster.
2920

30-
Then install the Stackable Commons Operator
21+
. Using xref:management:stackablectl:index.adoc[].
22+
. Using Helm.
23+
24+
[tabs]
25+
====
26+
stackablectl::
27+
+
28+
--
29+
`stackablectl` is the command line tool to interact with Stackable operators and our recommended way to install Operators.
30+
Follow the xref:management:stackablectl:installation.adoc[installation steps] for your platform.
31+
32+
After you have installed `stackablectl`, use it to install the Commons Operator:
3133
3234
[source,console]
33-
----
34-
$ helm install commons-operator stackable/commons-operator
35-
----
35+
$ stackablectl operator install commons=24.7.0
3636
37-
Helm will deploy the operator in Kubernetes and apply the CRDs.
37+
The tool will show:
38+
39+
[source]
40+
Installed commons=24.7.0 operator
3841
39-
== Building the operator from source
42+
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`. For
43+
example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
44+
--
4045
41-
After cloning the commons-operator repository you can use the following command to apply the CRDs:
46+
Helm::
47+
+
48+
--
49+
Helm allows you to download and deploy Stackable operators on Kubernetes.
50+
First ensure that you have installed the Stackable Operators Helm repository:
4251
4352
[source,console]
44-
----
45-
$ cargo run -- crd | kubectl apply -f -
46-
----
53+
$ helm repo add stackable \
54+
https://repo.stackable.tech/repository/helm-stable/
4755
48-
Use the following command to run the operator:
56+
Then install the Stackable Commons Operator
4957
5058
[source,console]
51-
----
52-
$ cargo run -- run
53-
----
59+
$ helm install --wait commons-operator \
60+
stackable-stable/commons-operator --version 24.7.0
61+
62+
Helm will deploy the operator in Kubernetes and apply the CRDs.
63+
--
64+
====

0 commit comments

Comments
 (0)