Skip to content

docs: Update helm install commands #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xeniape merged 1 commit into from
Apr 28, 2025
Merged

docs: Update helm install commands #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions docs/modules/airflow/examples/getting_started/code/getting_started.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,12 @@ helm install airflow-redis oci://registry-1.docker.io/bitnamicharts/redis \

case "$1" in
"helm")
echo "Adding 'stackable-dev' Helm Chart repository"
# tag::helm-add-repo[]
helm repo add stackable-dev https://repo.stackable.tech/repository/helm-dev/
# end::helm-add-repo[]
echo "Updating Helm repo"
helm repo update
echo "Installing Operators with Helm"
# tag::helm-install-operators[]
helm install --wait commons-operator stackable-dev/commons-operator --version 0.0.0-dev
helm install --wait secret-operator stackable-dev/secret-operator --version 0.0.0-dev
helm install --wait listener-operator stackable-dev/listener-operator --version 0.0.0-dev
helm install --wait airflow-operator stackable-dev/airflow-operator --version 0.0.0-dev
helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version 0.0.0-dev
helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version 0.0.0-dev
helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version 0.0.0-dev
helm install --wait airflow-operator oci://oci.stackable.tech/sdp-charts/airflow-operator --version 0.0.0-dev
# end::helm-install-operators[]
;;
"stackablectl")
Expand Down
14 changes: 4 additions & 10 deletions docs/modules/airflow/examples/getting_started/code/getting_started.sh.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,12 @@ helm install airflow-redis oci://registry-1.docker.io/bitnamicharts/redis \

case "$1" in
"helm")
echo "Adding '{{ helm.repo_name }}' Helm Chart repository"
# tag::helm-add-repo[]
helm repo add {{ helm.repo_name }} {{ helm.repo_url }}
# end::helm-add-repo[]
echo "Updating Helm repo"
helm repo update
echo "Installing Operators with Helm"
# tag::helm-install-operators[]
helm install --wait commons-operator {{ helm.repo_name }}/commons-operator --version {{ versions.commons }}
helm install --wait secret-operator {{ helm.repo_name }}/secret-operator --version {{ versions.secret }}
helm install --wait listener-operator {{ helm.repo_name }}/listener-operator --version {{ versions.listener }}
helm install --wait airflow-operator {{ helm.repo_name }}/airflow-operator --version {{ versions.airflow }}
helm install --wait commons-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/commons-operator --version {{ versions.commons }}
helm install --wait secret-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/secret-operator --version {{ versions.secret }}
helm install --wait listener-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/listener-operator --version {{ versions.listener }}
helm install --wait airflow-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/airflow-operator --version {{ versions.airflow }}
# end::helm-install-operators[]
;;
"stackablectl")
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/airflow/pages/getting_started/first_steps.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ It is set to `true` here as the example DAGs are used when verifying the install

NOTE: The version you need to specify for `spec.image.productVersion` is the desired version of Apache Airflow.
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.
Check our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable%airflow%2Ftags[image registry] for a list of available versions.
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].
It should generally be safe to simply use the latest version that is available.

This creates the actual Airflow cluster.
Expand Down
9 changes: 3 additions & 6 deletions docs/modules/airflow/pages/getting_started/installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,10 @@ Helm::
+
--
You can also use Helm to install the operators.
Add the Stackable Helm repository:
[source,bash]
----
include::example$getting_started/code/getting_started.sh[tag=helm-add-repo]
----

Then install the Stackable operators:
NOTE: `helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.

Install the Stackable operators:
[source,bash]
----
include::example$getting_started/code/getting_started.sh[tag=helm-install-operators]
Expand Down
4 changes: 2 additions & 2 deletions docs/templating_vars.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
helm:
repo_name: stackable-dev
repo_url: https://repo.stackable.tech/repository/helm-dev/
repo_name: sdp-charts
repo_url: oci.stackable.tech
versions:
commons: 0.0.0-dev
secret: 0.0.0-dev
Expand Down
4 changes: 2 additions & 2 deletions examples/simple-airflow-cluster-ldap-insecure-tls.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ secret-operator secret-operator
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ commons-operator commons-operator
# helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator
# helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator
# 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
# helm install --repo https://charts.bitnami.com/bitnami --version 17.3.7 --set auth.password=redis --set replica.replicaCount=1 airflow-redis redis
# Log in with user01/user01 or user02/user02
Expand Down
4 changes: 2 additions & 2 deletions examples/simple-airflow-cluster-ldap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ secret-operator secret-operator
# helm install --repo https://repo.stackable.tech/repository/helm-stable/ commons-operator commons-operator
# helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator
# helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator
# 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
# helm install --repo https://charts.bitnami.com/bitnami --version 17.3.7 --set auth.password=redis --set replica.replicaCount=1 airflow-redis redis
# Log in with user01/user01 or user02/user02
Expand Down