From 1e94144a32d51bf3668a2e03859f4026bdd22f35 Mon Sep 17 00:00:00 2001 From: xeniape Date: Fri, 25 Apr 2025 13:55:48 +0200 Subject: [PATCH] docs: Update helm install commands --- .../getting_started/getting_started.sh | 18 ++++++------------ .../getting_started/getting_started.sh.j2 | 18 ++++++------------ .../pages/getting_started/first_steps.adoc | 2 +- .../pages/getting_started/installation.adoc | 6 +----- docs/templating_vars.yaml | 4 ++-- 5 files changed, 16 insertions(+), 32 deletions(-) diff --git a/docs/modules/hbase/examples/getting_started/getting_started.sh b/docs/modules/hbase/examples/getting_started/getting_started.sh index 56ba560d..b0ea6b16 100755 --- a/docs/modules/hbase/examples/getting_started/getting_started.sh +++ b/docs/modules/hbase/examples/getting_started/getting_started.sh @@ -19,20 +19,14 @@ cd "$(dirname "$0")" 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 zookeeper-operator stackable-dev/zookeeper-operator --version 0.0.0-dev & -helm install --wait hdfs-operator stackable-dev/hdfs-operator --version 0.0.0-dev & -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 hbase-operator stackable-dev/hbase-operator --version 0.0.0-dev & +helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version 0.0.0-dev & +helm install --wait hdfs-operator oci://oci.stackable.tech/sdp-charts/hdfs-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 hbase-operator oci://oci.stackable.tech/sdp-charts/hbase-operator --version 0.0.0-dev & wait # end::helm-install-operators[] ;; diff --git a/docs/modules/hbase/examples/getting_started/getting_started.sh.j2 b/docs/modules/hbase/examples/getting_started/getting_started.sh.j2 index a4fef01c..7f474d2c 100755 --- a/docs/modules/hbase/examples/getting_started/getting_started.sh.j2 +++ b/docs/modules/hbase/examples/getting_started/getting_started.sh.j2 @@ -19,20 +19,14 @@ cd "$(dirname "$0")" 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 zookeeper-operator {{ helm.repo_name }}/zookeeper-operator --version {{ versions.zookeeper }} & -helm install --wait hdfs-operator {{ helm.repo_name }}/hdfs-operator --version {{ versions.hdfs }} & -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 hbase-operator {{ helm.repo_name }}/hbase-operator --version {{ versions.hbase }} & +helm install --wait zookeeper-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/zookeeper-operator --version {{ versions.zookeeper }} & +helm install --wait hdfs-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/hdfs-operator --version {{ versions.hdfs }} & +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 hbase-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/hbase-operator --version {{ versions.hbase }} & wait # end::helm-install-operators[] ;; diff --git a/docs/modules/hbase/pages/getting_started/first_steps.adoc b/docs/modules/hbase/pages/getting_started/first_steps.adoc index 6211d77d..21a75628 100644 --- a/docs/modules/hbase/pages/getting_started/first_steps.adoc +++ b/docs/modules/hbase/pages/getting_started/first_steps.adoc @@ -47,7 +47,7 @@ Where: NOTE: Please note that the version you need to specify for `spec.image.productVersion` is the desired version of Apache HBase. You can optionally specify the `spec.image.stackableVersion` to a certain release like `24.7.0` but it is recommended to leave it out and use the default provided by the operator. -For a list of available versions please check our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable%2Fhbase%2Ftags[image registry]. +Available official images are stored in the Stackable https://oci.stackable.tech/[image registry,window=_blank]. 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 image version that is available. Create the actual HDFS cluster by applying the file: diff --git a/docs/modules/hbase/pages/getting_started/installation.adoc b/docs/modules/hbase/pages/getting_started/installation.adoc index 68eafc41..468a673c 100644 --- a/docs/modules/hbase/pages/getting_started/installation.adoc +++ b/docs/modules/hbase/pages/getting_started/installation.adoc @@ -36,11 +36,7 @@ For example, you can use the `--cluster kind` flag to create a Kubernetes cluste Helm:: + -- -Add the Stackable Helm repository: -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=helm-add-repo] ----- +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] diff --git a/docs/templating_vars.yaml b/docs/templating_vars.yaml index 259c1d62..5ab6cf20 100644 --- a/docs/templating_vars.yaml +++ b/docs/templating_vars.yaml @@ -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