Skip to content

Commit 6b1a294

Browse files
xeniapexeniape
authored
docs: Update helm install commands (#617)
1 parent 2f81ab0 commit 6b1a294

File tree

7 files changed

+18
-33
lines changed

7 files changed

+18
-33
lines changed

‎docs/modules/airflow/examples/getting_started/code/getting_started.sh

+4-10
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,12 @@ helm install airflow-redis oci://registry-1.docker.io/bitnamicharts/redis \
3636

3737
case "$1" in
3838
"helm")
39-
echo "Adding 'stackable-dev' Helm Chart repository"
40-
# tag::helm-add-repo[]
41-
helm repo add stackable-dev https://repo.stackable.tech/repository/helm-dev/
42-
# end::helm-add-repo[]
43-
echo "Updating Helm repo"
44-
helm repo update
4539
echo "Installing Operators with Helm"
4640
# tag::helm-install-operators[]
47-
helm install --wait commons-operator stackable-dev/commons-operator --version 0.0.0-dev
48-
helm install --wait secret-operator stackable-dev/secret-operator --version 0.0.0-dev
49-
helm install --wait listener-operator stackable-dev/listener-operator --version 0.0.0-dev
50-
helm install --wait airflow-operator stackable-dev/airflow-operator --version 0.0.0-dev
41+
helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version 0.0.0-dev
42+
helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version 0.0.0-dev
43+
helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version 0.0.0-dev
44+
helm install --wait airflow-operator oci://oci.stackable.tech/sdp-charts/airflow-operator --version 0.0.0-dev
5145
# end::helm-install-operators[]
5246
;;
5347
"stackablectl")

‎docs/modules/airflow/examples/getting_started/code/getting_started.sh.j2

+4-10
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,12 @@ helm install airflow-redis oci://registry-1.docker.io/bitnamicharts/redis \
3636

3737
case "$1" in
3838
"helm")
39-
echo "Adding '{{ helm.repo_name }}' Helm Chart repository"
40-
# tag::helm-add-repo[]
41-
helm repo add {{ helm.repo_name }} {{ helm.repo_url }}
42-
# end::helm-add-repo[]
43-
echo "Updating Helm repo"
44-
helm repo update
4539
echo "Installing Operators with Helm"
4640
# tag::helm-install-operators[]
47-
helm install --wait commons-operator {{ helm.repo_name }}/commons-operator --version {{ versions.commons }}
48-
helm install --wait secret-operator {{ helm.repo_name }}/secret-operator --version {{ versions.secret }}
49-
helm install --wait listener-operator {{ helm.repo_name }}/listener-operator --version {{ versions.listener }}
50-
helm install --wait airflow-operator {{ helm.repo_name }}/airflow-operator --version {{ versions.airflow }}
41+
helm install --wait commons-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/commons-operator --version {{ versions.commons }}
42+
helm install --wait secret-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/secret-operator --version {{ versions.secret }}
43+
helm install --wait listener-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/listener-operator --version {{ versions.listener }}
44+
helm install --wait airflow-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/airflow-operator --version {{ versions.airflow }}
5145
# end::helm-install-operators[]
5246
;;
5347
"stackablectl")

‎docs/modules/airflow/pages/getting_started/first_steps.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ It is set to `true` here as the example DAGs are used when verifying the install
7171

7272
NOTE: The version you need to specify for `spec.image.productVersion` is the desired version of Apache Airflow.
7373
You can optionally specify the `spec.image.stackableVersion` to a certain release like `23.11.0` but it is recommended to leave it out and use the default provided by the operator.
74-
Check our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable%airflow%2Ftags[image registry] for a list of available versions.
74+
Check our https://oci.stackable.tech/[image registry,window=_blank] for a list of available versions. Information on how to browse the registry can be found xref:contributor:project-overview.adoc#docker-images[here,window=_blank].
7575
It should generally be safe to simply use the latest version that is available.
7676

7777
This creates the actual Airflow cluster.

‎docs/modules/airflow/pages/getting_started/installation.adoc

+3-6
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,10 @@ Helm::
5858
+
5959
--
6060
You can also use Helm to install the operators.
61-
Add the Stackable Helm repository:
62-
[source,bash]
63-
----
64-
include::example$getting_started/code/getting_started.sh[tag=helm-add-repo]
65-
----
6661
67-
Then install the Stackable operators:
62+
NOTE: `helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.
63+
64+
Install the Stackable operators:
6865
[source,bash]
6966
----
7067
include::example$getting_started/code/getting_started.sh[tag=helm-install-operators]

‎docs/templating_vars.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
helm:
3-
repo_name: stackable-dev
4-
repo_url: https://repo.stackable.tech/repository/helm-dev/
3+
repo_name: sdp-charts
4+
repo_url: oci.stackable.tech
55
versions:
66
commons: 0.0.0-dev
77
secret: 0.0.0-dev

‎examples/simple-airflow-cluster-ldap-insecure-tls.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ secret-operator secret-operator
2-
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ commons-operator commons-operator
1+
# helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator
2+
# helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator
33
# helm install --repo https://charts.bitnami.com/bitnami --version 12.1.5 --set auth.username=airflow --set auth.password=airflow --set auth.database=airflow airflow-postgresql postgresql
44
# helm install --repo https://charts.bitnami.com/bitnami --version 17.3.7 --set auth.password=redis --set replica.replicaCount=1 airflow-redis redis
55
# Log in with user01/user01 or user02/user02

‎examples/simple-airflow-cluster-ldap.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ secret-operator secret-operator
2-
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ commons-operator commons-operator
1+
# helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator
2+
# helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator
33
# helm install --repo https://charts.bitnami.com/bitnami --version 12.1.5 --set auth.username=airflow --set auth.password=airflow --set auth.database=airflow airflow-postgresql postgresql
44
# helm install --repo https://charts.bitnami.com/bitnami --version 17.3.7 --set auth.password=redis --set replica.replicaCount=1 airflow-redis redis
55
# Log in with user01/user01 or user02/user02

0 commit comments

Comments
 (0)