removing post-renderer from OpenShift docs (#4129)

* removing post-renderer * adding changes to all versions * removing links to repo and adding artifact hub link * taking out the word repository
camunda · Aug 8, 2024 · 6c49488 · 6c49488
1 parent 49820bc
commit 6c49488
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 33 deletions.
diff --git a/docs/self-managed/setup/deploy/openshift/redhat-openshift.md b/docs/self-managed/setup/deploy/openshift/redhat-openshift.md
@@ -41,37 +41,31 @@ Depending on your OpenShift cluster's Security Context Constraints (SCCs) config
 
 ### With restrictive SCCs
 
-By default, OpenShift employs more restrictive SCCs. The Helm chart must assign `null` to the user running all components and dependencies. Due to a [null bug](https://github.com/helm/helm/issues/9136) [in Helm](https://github.com/helm/helm/issues/12490), this operation must be executed using [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering).
+By default, OpenShift employs more restrictive SCCs. The Helm chart must assign `null` to the user running all components and dependencies. Due to a [null bug](https://github.com/helm/helm/issues/9136) [in Helm](https://github.com/helm/helm/issues/12490), this operation must be executed using our OpenShift values.yaml
 
 To deploy Camunda 8 on OpenShift, please follow these installation steps:
 
 1. Install [Helm and other CLI tools](/self-managed/setup/install.md#prerequisites).
-2. Ensure that `bash` and `sed` on linux or `gsed` on mac are available locally, as they are necessary for the [post-rendering process to patch the values of OpenShift](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform-latest/openshift/patch.sh).
-3. Install the [Camunda Helm chart repository](/self-managed/setup/install.md#helm-repository).
-4. Download the exact version of the chart that you want to install and extract it in a directory ([Camunda 8 Helm Chart Version Matrix](https://helm.camunda.io/camunda-platform/version-matrix/)):
+2. Install the [Camunda Helm chart repository](/self-managed/setup/install.md#helm-repository).
+3. Download the exact version of the chart that you want to install and extract it in a directory ([Camunda 8 Helm Chart Version Matrix](https://helm.camunda.io/camunda-platform/version-matrix/)):
 
 ```shell
-# List of available version: https://helm.camunda.io/camunda-platform/version-matrix/
-export CHART_VERSION="pleaseDefine"
+# List of available versions: https://helm.camunda.io/camunda-platform/version-matrix/
+export CHART_VERSION="<DESIRED_CHART_VERSION>"
 
 # Make sure to set CHART_VERSION to match the chart version you want to install.
 helm pull camunda/camunda-platform --version "$CHART_VERSION" --untar --untardir "/tmp/camunda-platform-$CHART_VERSION"
 ```
 
-5. Install the Camunda chart with the patched SCCs (`/tmp/camunda-platform-CHART_VERSION/camunda-platform/openshift/values.yaml`) and the post-renderer script (`/tmp/camunda-platform-CHART_VERSION/camunda-platform/openshift/patch.sh`):
+5. Install the Camunda chart with the patched SCCs (`/tmp/camunda-platform-CHART_VERSION/camunda-platform/openshift/values.yaml`)
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds       \
-    --values "/tmp/camunda-platform-$CHART_VERSION/camunda-platform/openshift/values.yaml"   \
-    --post-renderer bash --post-renderer-args "/tmp/camunda-platform-$CHART_VERSION/camunda-platform/openshift/patch.sh"
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" \
+    --values "/tmp/camunda-platform-$CHART_VERSION/camunda-platform/openshift/values.yaml"
 ```
 
 You can customize the values by providing your own values in addition to the OpenShift values file.
 
-:::note Always use the post-renderer
-For updates as well as the initial installation. Skipping it will reapply default values and may prevent some services from starting.
-:::
-
   </TabItem>
   <TabItem value="no-scc" label="Permissive SCCs">
 

diff --git a/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md b/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md
@@ -117,7 +117,7 @@ v3.8.1+g5cb9af4
 If you're running on Helm 3.0.0 up to 3.1.3, you need to add these values to your `values.yaml` file, or save them to a new file locally, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -167,12 +167,12 @@ identity:
 When installing the chart, run the following:
 
 ```shell
-helm install camunda camunda/camunda-platform--skip-crds -f values.yaml -f openshift.yaml
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" -f values.yaml -f openshift.yaml
 ```
 
 #### Helm 3.2.0 and greater
 
-If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering). This workaround is also described in detail in the [Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift#post-renderer-setup).
+If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering).
 
 :::warning
 If using a post-renderer, you **must** use the post-renderer whenever you are updating your release, not only during the initial installation. If you do not, the default values will be used again, which will prevent some services from starting.
@@ -208,7 +208,7 @@ You also need to use a custom values file, where instead of using `null` as a va
 Copy these values to your values file or save them as a separate file, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/openshift/values.yaml).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -258,7 +258,7 @@ identity:
 Now, when installing the chart, you can do so by running the following:
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds \
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" \
     -f values.yaml -f openshift.yaml --post-renderer ./patch.sh
 ```
 

diff --git a/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md b/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md
@@ -116,7 +116,7 @@ v3.8.1+g5cb9af4
 If you're running on Helm 3.0.0 up to 3.1.3, you need to add these values to your `values.yaml` file, or save them to a new file locally, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -166,12 +166,12 @@ identity:
 When installing the chart, run the following:
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds -f values.yaml -f openshift.yaml
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" -f values.yaml -f openshift.yaml
 ```
 
 #### Helm 3.2.0 and greater
 
-If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering). This workaround is also described in detail in the [Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift#post-renderer-setup).
+If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering).
 
 :::warning
 If using a post-renderer, you **must** use the post-renderer whenever you are updating your release, not only during the initial installation. If you do not, the default values will be used again, which will prevent some services from starting.
@@ -207,7 +207,7 @@ You also need to use a custom values file, where instead of using `null` as a va
 Copy these values to your values file or save them as a separate file, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/openshift/values.yaml).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -257,7 +257,7 @@ identity:
 Now, when installing the chart, you can do so by running the following:
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds \
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" \
     -f values.yaml -f openshift.yaml --post-renderer ./patch.sh
 ```
 

diff --git a/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md b/.../self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md
@@ -116,7 +116,7 @@ v3.8.1+g5cb9af4
 If you're running on Helm 3.0.0 up to 3.1.3, you need to add these values to your `values.yaml` file, or save them to a new file locally, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -166,12 +166,12 @@ identity:
 When installing the chart, run the following:
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds -f values.yaml -f openshift.yaml
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" -f values.yaml -f openshift.yaml
 ```
 
 #### Helm 3.2.0 and greater
 
-If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering). This workaround is also described in detail in the [Helm chart repository](https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform/openshift#post-renderer-setup).
+If you must deploy using Helm 3.2.0 or greater, you have two options. One is to use a SCCs which defines the `RunAsUser` strategy to be at least `RunAsAny`. If that's not possible, then you need to make use of [a post-renderer](https://helm.sh/docs/topics/advanced/#post-rendering).
 
 :::warning
 If using a post-renderer, you **must** use the post-renderer whenever you are updating your release, not only during the initial installation. If you do not, the default values will be used again, which will prevent some services from starting.
@@ -207,7 +207,7 @@ You also need to use a custom values file, where instead of using `null` as a va
 Copy these values to your values file or save them as a separate file, e.g. `openshift.yaml`:
 
 :::note
-These values are also available in the [Camunda Helm chart repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/openshift/values.yaml).
+These values are also available in the [Camunda Helm chart](https://artifacthub.io/packages/helm/camunda/camunda-platform).
 :::
 
 ```yaml
@@ -257,7 +257,7 @@ identity:
 Now, when installing the chart, you can do so by running the following:
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds \
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" \
     -f values.yaml -f openshift.yaml --post-renderer ./patch.sh
 ```
 

diff --git a/versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md b/versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
@@ -46,13 +46,13 @@ By default, OpenShift employs more restrictive SCCs. The Helm chart must assign
 To deploy Camunda 8 on OpenShift, please follow these installation steps:
 
 1. Install [Helm and other CLI tools](/self-managed/setup/install.md#prerequisites).
-2. Ensure that `bash` and `sed` on linux or `gsed` on mac are available locally, as they are necessary for the [post-rendering process to patch the values of OpenShift](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/openshift/patch.sh).
+2. Ensure that `bash` and `sed` on linux or `gsed` on mac are available locally, as they are necessary for the post-rendering process to patch the values of OpenShift
 3. Install the [Camunda Helm chart repository](/self-managed/setup/install.md#helm-repository).
 4. Download the exact version of the chart that you want to install and extract it in a directory ([Camunda 8 Helm Chart Version Matrix](https://helm.camunda.io/camunda-platform/version-matrix/)):
 
 ```shell
-# List of available version: https://helm.camunda.io/camunda-platform/version-matrix/
-export CHART_VERSION="pleaseDefine"
+# List of available versions: https://helm.camunda.io/camunda-platform/version-matrix/
+export CHART_VERSION="<DESIRED_CHART_VERSION>"
 
 # Make sure to set CHART_VERSION to match the chart version you want to install.
 helm pull camunda/camunda-platform --version "$CHART_VERSION" --untar --untardir "/tmp/camunda-platform-$CHART_VERSION"
@@ -61,7 +61,7 @@ helm pull camunda/camunda-platform --version "$CHART_VERSION" --untar --untardir
 5. Install the Camunda chart with the patched SCCs (`/tmp/camunda-platform-CHART_VERSION/camunda-platform/openshift/values.yaml`) and the post-renderer script (`/tmp/camunda-platform-CHART_VERSION/camunda-platform/openshift/patch.sh`):
 
 ```shell
-helm install camunda camunda/camunda-platform --skip-crds       \
+helm install camunda camunda/camunda-platform --skip-crds --version "$CHART_VERSION" \
     --values "/tmp/camunda-platform-$CHART_VERSION/camunda-platform/openshift/values.yaml"   \
     --post-renderer bash --post-renderer-args "/tmp/camunda-platform-$CHART_VERSION/camunda-platform/openshift/patch.sh"
 ```