From 64fad394eadddcce7455ec498e59e0ba95599499 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Sun, 9 Feb 2025 16:34:52 +0000 Subject: [PATCH 01/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 5 ----- 1 file changed, 5 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 141d0819c5..e29372e993 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -49,11 +49,6 @@ spec: claimName: dynamic-plugins-root ---- -[NOTE] -==== -Future versions of the {product-very-short} operator are planned to automatically create the PVC. -==== - == Configuring the dynamic plugins cache You can set the following optional dynamic plugin cache parameters: From 0b088de4d0f3da7f0bd7c2d0bfba7bb25e74127c Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Fri, 7 Feb 2025 21:59:53 +0100 Subject: [PATCH 02/23] RHDH-5561: TechDocs content restructure (#917) Co-authored-by: linfraze --- assemblies/assembly-configuring-techdocs.adoc | 29 +------------------ modules/techdocs/con-techdocs-about.adoc | 21 ++++++++++++++ titles/techdocs/artifacts | 1 + titles/techdocs/assemblies | 1 + titles/techdocs/docinfo.xml | 13 +++++++++ titles/techdocs/images | 1 + titles/techdocs/master.adoc | 13 +++++++++ titles/techdocs/modules | 1 + 8 files changed, 52 insertions(+), 28 deletions(-) create mode 100644 modules/techdocs/con-techdocs-about.adoc create mode 120000 titles/techdocs/artifacts create mode 120000 titles/techdocs/assemblies create mode 100644 titles/techdocs/docinfo.xml create mode 120000 titles/techdocs/images create mode 100644 titles/techdocs/master.adoc create mode 120000 titles/techdocs/modules diff --git a/assemblies/assembly-configuring-techdocs.adoc b/assemblies/assembly-configuring-techdocs.adoc index 2242fb5151..9c35554c7c 100644 --- a/assemblies/assembly-configuring-techdocs.adoc +++ b/assemblies/assembly-configuring-techdocs.adoc @@ -3,24 +3,7 @@ [id="{context}"] = Configuring TechDocs -Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way. For example: - -Docs-like-code approach:: -Write your technical documentation in Markdown files that are stored inside your project repository along with your code. - -Documentation site generation:: -Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}. - -Documentation site metadata and integrations:: -See additional metadata about the documentation site alongside the static documentation, such as the date of the last update, the site owner, top contributors, open GitHub issues, Slack support channels, and Stack Overflow Enterprise tags. - -Built-in navigation and search:: -Find the information that you want from a document more quickly and easily. - -Add-ons:: -Customize your TechDocs experience with Add-ons to address higher-order documentation needs. - -The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator config map. +The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap. [IMPORTANT] ==== @@ -38,30 +21,20 @@ After you configure {odf-name} to store the files that TechDocs generates, you c include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1] - include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2] - include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3] - include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2] - include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3] - include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1] - include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2] - diff --git a/modules/techdocs/con-techdocs-about.adoc b/modules/techdocs/con-techdocs-about.adoc new file mode 100644 index 0000000000..9b3a854104 --- /dev/null +++ b/modules/techdocs/con-techdocs-about.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: CONCEPT + +[id="about-techdocs_{context}"] += About TechDocs + +The {product} instance comes with the TechDocs plugin preinstalled and enabled by default. Your organization can use the TechDocs plugin to create, find, and manage documentation in a central location and in a standardized way. You can also enhance your technical documentation experience with built-in TechDocs features and add-ons. For example: + +Docs-like-code approach:: +Write your technical documentation in Markdown files that are stored inside your project repository along with your code. + +Documentation site generation:: +Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}. + +Documentation site metadata and integrations:: +See additional metadata about the documentation site alongside the static documentation, such as the date of the last update, the site owner, top contributors, open GitHub issues, Slack support channels, and Stack Overflow Enterprise tags. + +Built-in navigation and search:: +Locate the information that you need within a document quickly and easily. + +Add-ons:: +Customize your TechDocs experience with add-ons to address higher-order documentation needs. diff --git a/titles/techdocs/artifacts b/titles/techdocs/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/techdocs/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/techdocs/assemblies b/titles/techdocs/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/techdocs/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/techdocs/docinfo.xml b/titles/techdocs/docinfo.xml new file mode 100644 index 0000000000..42d897b71d --- /dev/null +++ b/titles/techdocs/docinfo.xml @@ -0,0 +1,13 @@ +TechDocs for {product} +{product} +{product-version} + + + + Your organization can use the built-in TechDocs plugin for {product} to create, find, and use technical documentation in a central location and in a standardized way. Use supported TechDocs add-ons, or create your own, to further enhance your documentation experience. + + + {company-name} Customer Content Services + + diff --git a/titles/techdocs/images b/titles/techdocs/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/techdocs/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/techdocs/master.adoc b/titles/techdocs/master.adoc new file mode 100644 index 0000000000..649b8bb685 --- /dev/null +++ b/titles/techdocs/master.adoc @@ -0,0 +1,13 @@ +[id="title-techdocs-rhdh"] +include::artifacts/attributes.adoc[] += TechDocs for {product} +:context: title-techdocs-rhdh +:imagesdir: images + +// about techdocs +include::modules/techdocs/con-techdocs-about.adoc[leveloffset=+1] + +// techdocs configuration +include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] + +// techdocs add-ons diff --git a/titles/techdocs/modules b/titles/techdocs/modules new file mode 120000 index 0000000000..8b0e854007 --- /dev/null +++ b/titles/techdocs/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file From 15f8952ebb7a556b051a2028cec504a53043d843 Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Thu, 13 Feb 2025 10:52:30 +0100 Subject: [PATCH 03/23] Changed alpha2 to alpha3 (#928) Co-authored-by: Priyanka Abel --- ...nfiguring-deployment-by-using-the-operator.adoc | 14 +++++++------- .../dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc index ebdcaf9636..24623fced2 100644 --- a/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc +++ b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc @@ -1,7 +1,7 @@ [id="configuring-the-deployment"] = Configuring {product} deployment when using the Operator -The {product} Operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object. +The {product} Operator exposes a `rhdh.redhat.com/v1alpha3` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object. .Procedure @@ -11,7 +11,7 @@ The {product} Operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its c .Example [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub @@ -28,7 +28,7 @@ Add labels to the {product-short} pod. .Example adding the label `my=true` [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub @@ -50,7 +50,7 @@ Add an additional volume named `my-volume` and mount it under `/my/path` in the .Example additional volume [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub @@ -78,7 +78,7 @@ Replace the default `dynamic-plugins-root` volume with a persistent volume claim .Example `dynamic-plugins-root` volume replacement [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub @@ -103,7 +103,7 @@ Set the CPU request for the {product-short} application container to 250m. .Example CPU request [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub @@ -127,7 +127,7 @@ Add a new `my-sidecar` sidecar container into the {product-short} Pod. .Example side car container [source, yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index e29372e993..fc406a89fb 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -32,7 +32,7 @@ spec: --- -apiVersion: rhdh.redhat.com/v1alpha2 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: developer-hub From db77e5fa317ed3a6da71dfe0af0e467ecd923f56 Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Fri, 14 Feb 2025 16:06:25 +0100 Subject: [PATCH 04/23] [release-1.5] RHIDP-5592:Wrong definition of Service Monitor for an RHDH instance by the Operator (#937) * fixed merge conflicts * Incorporated Jessica's comments * Made a few changes * Final changes * Incorporated Lindsey's comments * Final update * Incorporated comments * Incorporated comment --------- Co-authored-by: Priyanka Abel --- ...c-admin-enabling-metrics-ocp-operator.adoc | 27 +++++++++++++------ 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc index f169e2f3a0..921ed4d11b 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc @@ -25,24 +25,34 @@ Currently, the {product} Operator does not support creating a `ServiceMonitor` c apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: - name: # <1> - namespace: {my-product-namespace} # <2> + name: __ <1> + namespace: __ <2> labels: - app.kubernetes.io/instance: - app.kubernetes.io/name: backstage + app.kubernetes.io/instance: __ <3> + app.kubernetes.io/name: {product-custom-resource-type} spec: namespaceSelector: matchNames: - - {my-product-namespace} + - __ <4> selector: matchLabels: - rhdh.redhat.com/app: backstage- + app.kubernetes.io/instance: __ <5> + app.kubernetes.io/name: __ <6> endpoints: - port: http-metrics path: '/metrics' ---- -<1> Replace `` with the name of your `{product-custom-resource-type}` custom resource. -<2> Replace `` with the name of the {ocp-short} project where your {product} instance is running. +<1> The name of your `ServiceMonitor` resource, for example, `developer_hub_service_monitor`. +<2> The namespace where your `ServiceMonitor` will live, for example, `{my-product-namespace}`. +<3> The label name identifying the `ServiceMonitor` CR instance, for example, `{my-product-cr-name}`. +<4> The namespace where your {product-very-short} instance is installed, for example, `{my-product-namespace}`. +<5> The name of your {product-very-short} deployment, for example, `developer-hub`. +<6> The name of your {product-very-short} application, for example, `backstage`. ++ +[NOTE] +==== +`spec.selector.matchLabels` configuration must match the labels of your {product-very-short} installation. +==== . Apply the `ServiceMonitor` CR by running the following command: + @@ -55,3 +65,4 @@ oc apply -f . From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view. . Click the *Metrics* tab to view metrics for {product} pods. +. From the Developer perspective in the {ocp-short} web console, click **Project > Services** and verify the labels for `backstage-developer-hub`. From 0ceed19b5983f4dcbda6fdc54bbf0fe3e45bfa3d Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Mon, 17 Feb 2025 10:01:13 +0100 Subject: [PATCH 05/23] chore: bad link in code snippet points to non-existent branch (#940) Co-authored-by: Nick Boldt --- .../proc-install-rhdh-airgapped-environment-ocp-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc index 815c61bd3a..2fa83f8e19 100644 --- a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc @@ -45,7 +45,7 @@ The internal {ocp-short} cluster image registry cannot be used as a target mirro + [source,yaml,subs="attributes+"] ---- -curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/{product-version}.x/.rhdh/scripts/prepare-restricted-environment.sh +curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh # if you do not already have a target mirror registry # and want the script to create one for you From 68f9b4c33079339b94ac8738e2f2f9d36902db27 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Wed, 26 Feb 2025 17:31:51 +0000 Subject: [PATCH 06/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- .../con-dynamic-plugins-cache.adoc | 89 ++++++++++++++++++- 1 file changed, 86 insertions(+), 3 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index fc406a89fb..73a86fb4bb 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -13,10 +13,16 @@ When you enable dynamic plugins cache: == Enabling the dynamic plugins cache To enable the dynamic plugins cache in {product-very-short}, the plugins directory `dynamic-plugins-root` must be a persistent volume. -For Helm chart installations, a persistent volume named `dynamic-plugins-root` is automatically created. +// For Helm chart installations, a persistent volume named `dynamic-plugins-root` is automatically created. -For operator-based installations, you must manually create the PersistentVolumeClaim (PVC) as follows: +=== Creating a PVC for Dynamic Plugins Cache using the Operator +// For operator-based installations, you must manually create the PersistentVolumeClaim (PVC) as follows: +For operator-based installations, you must manually create the PersistentVolumeClaim (PVC) by replacing the default `dynamic-plugins-root` volume with a Persistent Volume Claim (PVC) named `dynamic-plugins-root`. + +Create the persistent volume definition and save it to a file, for example `pvc.yaml`. + +.Example creating the persistent volume definition [source,yaml] ---- kind: PersistentVolumeClaim @@ -29,10 +35,18 @@ spec: resources: requests: storage: 5Gi +---- ---- +Replace the default dynamic-plugins-root volume with a persistent volume claim (PVC) named dynamic-plugins-root. +<<<<<<< HEAD apiVersion: rhdh.redhat.com/v1alpha3 +======= +.Example replacing the `dynamic-plugins-root` volume +[source,yaml] +---- +apiVersion: rhdh.redhat.com/v1alpha2 +>>>>>>> 5ef6a4fa9 (RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default) kind: Backstage metadata: name: developer-hub @@ -49,6 +63,75 @@ spec: claimName: dynamic-plugins-root ---- +[NOTE] +To avoid adding a new volume, you must use the `$patch: replace` directive. + +=== Creating a PVC for Dynamic Plugins Cache using the Helm Chart +For Helm Chart installations, if you require the dynamic plugin cache to persist across pod restarts, you must create a PersistentVolumeClaim (PVC) and configure the Helm Chart to use it. + +.Example creating the persistent volume definition +[source,yaml] +---- +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: dynamic-plugins-root +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 5Gi + +---- + +[NOTE] +==== +This example uses `ReadWriteOnce` as the access mode which prevents multiple replicas from sharing the PVC across different nodes. + +To run multiple replicas on different nodes, depending on your storage driver, you must use an access mode such as `ReadWriteMany`. +==== + +To apply this PVC to your cluster, run the following command: +[source,terminal] +---- +oc apply -f pvc.yaml +---- + +.Example configuring Helm to use the PVC +[source,yaml] +---- +extraVolumes: + - name: dynamic-plugins-root + persistentVolumeClaim: + claimName: dynamic-plugins-root + - name: dynamic-plugins + configMap: + defaultMode: 420 + name: '{{ printf "%s-dynamic-plugins" .Release.Name }}' + optional: true + - name: dynamic-plugins-npmrc + secret: + defaultMode: 420 + optional: true + secretName: '{{ printf "%s-dynamic-plugins-npmrc" .Release.Name }}' + - name: dynamic-plugins-registry-auth + secret: + defaultMode: 416 + optional: true + secretName: '{{ printf "%s-dynamic-plugins-registry-auth" .Release.Name }}' + - name: npmcacache + emptyDir: {} + - name: temp + emptyDir: {}= +---- + +To deploy the Helm Chart, run the following command: +[source,terminal] +---- +helm upgrade --install rhdh-backstage charts/backstage --namespace rhdh -f values.yaml +---- + == Configuring the dynamic plugins cache You can set the following optional dynamic plugin cache parameters: From d76102c562b7814e4d4af8d1987e2aab49d1ba58 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Tue, 11 Mar 2025 16:06:58 +0000 Subject: [PATCH 07/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 482803a2bd..277a59e785 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -115,7 +115,7 @@ extraVolumes: - name: npmcacache emptyDir: {} - name: temp - emptyDir: {}= + emptyDir: {} ---- To deploy the Helm Chart, run the following command: From 292ccc2b4cfbebb1e819b1cbbee57ff04f05b906 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Tue, 11 Mar 2025 16:54:42 +0000 Subject: [PATCH 08/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- .../con-dynamic-plugins-cache.adoc | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 277a59e785..088dea74d5 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -33,6 +33,19 @@ spec: storage: 5Gi ---- +[NOTE] +==== +This example uses `ReadWriteOnce` as the access mode which prevents multiple replicas from sharing the PVC across different nodes. + +To run multiple replicas on different nodes, depending on your storage driver, you must use an access mode such as `ReadWriteMany`. +==== + +To apply this PVC to your cluster, run the following command: +[source,terminal] +---- +oc apply -f pvc.yaml +---- + Replace the default dynamic-plugins-root volume with a persistent volume claim (PVC) named dynamic-plugins-root. .Example replacing the `dynamic-plugins-root` volume @@ -118,12 +131,6 @@ extraVolumes: emptyDir: {} ---- -To deploy the Helm Chart, run the following command: -[source,terminal] ----- -helm upgrade --install rhdh-backstage charts/backstage --namespace rhdh -f values.yaml ----- - == Configuring the dynamic plugins cache You can set the following optional dynamic plugin cache parameters: From 0a05d708fcb7ef0dbb74229b00e50ca477e4de81 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Tue, 11 Mar 2025 17:39:24 +0000 Subject: [PATCH 09/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 088dea74d5..c91c48784a 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -131,6 +131,11 @@ extraVolumes: emptyDir: {} ---- +[NOTE] +==== +When you configure Helm to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. +==== + == Configuring the dynamic plugins cache You can set the following optional dynamic plugin cache parameters: From 4829854c799fe164c6bfac5cb8ad67d40fd80efd Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Tue, 11 Mar 2025 23:01:24 +0000 Subject: [PATCH 10/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index c91c48784a..10c8756057 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -13,7 +13,7 @@ When you enable dynamic plugins cache: == Enabling the dynamic plugins cache To enable the dynamic plugins cache in {product-very-short}, the plugins directory `dynamic-plugins-root` must be a persistent volume. -=== Creating a PVC for Dynamic Plugins Cache using the Operator +=== Creating a PVC for Dynamic Plugins Cache by using the Operator For operator-based installations, you must manually create the PersistentVolumeClaim (PVC) by replacing the default `dynamic-plugins-root` volume with a Persistent Volume Claim (PVC) named `dynamic-plugins-root`. Create the persistent volume definition and save it to a file, for example `pvc.yaml`. From 85ec70f024b2035a332838551d91af4852f13598 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Tue, 11 Mar 2025 23:02:59 +0000 Subject: [PATCH 11/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 10c8756057..080ffef8d5 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -14,7 +14,7 @@ When you enable dynamic plugins cache: To enable the dynamic plugins cache in {product-very-short}, the plugins directory `dynamic-plugins-root` must be a persistent volume. === Creating a PVC for Dynamic Plugins Cache by using the Operator -For operator-based installations, you must manually create the PersistentVolumeClaim (PVC) by replacing the default `dynamic-plugins-root` volume with a Persistent Volume Claim (PVC) named `dynamic-plugins-root`. +For operator-based installations, you must manually create the persistent volume claim (PVC) by replacing the default `dynamic-plugins-root` volume with a PVC named `dynamic-plugins-root`. Create the persistent volume definition and save it to a file, for example `pvc.yaml`. From cf9a630cd364e92386f23830f06b313a328fb2cd Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Tue, 11 Mar 2025 23:05:00 +0000 Subject: [PATCH 12/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 080ffef8d5..fcd882d212 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -133,7 +133,7 @@ extraVolumes: [NOTE] ==== -When you configure Helm to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. +When you configure the Helm chart to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. ==== == Configuring the dynamic plugins cache From 512ff7efbb4b11bd62d35cefbb4d831df9edc9f9 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:35:17 +0000 Subject: [PATCH 13/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index fcd882d212..73498d974a 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -16,9 +16,9 @@ To enable the dynamic plugins cache in {product-very-short}, the plugins directo === Creating a PVC for Dynamic Plugins Cache by using the Operator For operator-based installations, you must manually create the persistent volume claim (PVC) by replacing the default `dynamic-plugins-root` volume with a PVC named `dynamic-plugins-root`. -Create the persistent volume definition and save it to a file, for example `pvc.yaml`. +.Procedure -.Example creating the persistent volume definition +. Create the persistent volume definition and save it to a file, for example `pvc.yaml`. For example: [source,yaml] ---- kind: PersistentVolumeClaim From f57ee65a95c93120377f6425ce744d6f959fb494 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:35:36 +0000 Subject: [PATCH 14/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 73498d974a..821189577f 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -40,7 +40,7 @@ This example uses `ReadWriteOnce` as the access mode which prevents multiple rep To run multiple replicas on different nodes, depending on your storage driver, you must use an access mode such as `ReadWriteMany`. ==== -To apply this PVC to your cluster, run the following command: +. To apply this PVC to your cluster, run the following command: [source,terminal] ---- oc apply -f pvc.yaml From 0cf4859ca16f200226434cd646bd0660d4e9b4dd Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:35:57 +0000 Subject: [PATCH 15/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 821189577f..ce3c23f173 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -46,9 +46,8 @@ To run multiple replicas on different nodes, depending on your storage driver, y oc apply -f pvc.yaml ---- -Replace the default dynamic-plugins-root volume with a persistent volume claim (PVC) named dynamic-plugins-root. - -.Example replacing the `dynamic-plugins-root` volume +. Replace the default `dynamic-plugins-root` volume with a PVC named `dynamic-plugins-root`. For example: ++ [source,yaml] ---- apiVersion: rhdh.redhat.com/v1alpha3 From 63748e083a7114dab7c054982e08ee3d65c8b3df Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:36:14 +0000 Subject: [PATCH 16/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index ce3c23f173..889ca13a44 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -72,8 +72,10 @@ To avoid adding a new volume, you must use the `$patch: replace` directive. === Creating a PVC for Dynamic Plugins Cache using the Helm Chart For Helm Chart installations, if you require the dynamic plugin cache to persist across pod restarts, you must create a PersistentVolumeClaim (PVC) and configure the Helm Chart to use it. +.Procedure -.Example creating the persistent volume definition +. Create the persistent volume definition. For example: ++ [source,yaml] ---- kind: PersistentVolumeClaim @@ -86,7 +88,6 @@ spec: resources: requests: storage: 5Gi - ---- [NOTE] From 1b2b55eff17b7a9ea1b92a538d2ceb2748e26550 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:36:28 +0000 Subject: [PATCH 17/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 889ca13a44..29bdab92ea 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -97,7 +97,7 @@ This example uses `ReadWriteOnce` as the access mode which prevents multiple rep To run multiple replicas on different nodes, depending on your storage driver, you must use an access mode such as `ReadWriteMany`. ==== -To apply this PVC to your cluster, run the following command: +. To apply this PVC to your cluster, run the following command: [source,terminal] ---- oc apply -f pvc.yaml From 8f115d8543e4cc61bf9a337e281bcc615ada706a Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:36:44 +0000 Subject: [PATCH 18/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 29bdab92ea..ce2740e6ee 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -102,8 +102,8 @@ To run multiple replicas on different nodes, depending on your storage driver, y ---- oc apply -f pvc.yaml ---- - -.Example configuring Helm to use the PVC +. Configure the Helm chart to use the PVC. For example: ++ [source,yaml] ---- extraVolumes: From 684671486a6cd9c9308d42a3c0f034e1b4b14a0e Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Wed, 12 Mar 2025 09:37:23 +0000 Subject: [PATCH 19/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Armel Soro --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index ce2740e6ee..e6b3c7bca2 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -133,7 +133,7 @@ extraVolumes: [NOTE] ==== -When you configure the Helm chart to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/main/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. +When you configure the Helm chart to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/release-{product-version}/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. ==== == Configuring the dynamic plugins cache From dcbf32b6cccac59224224301046fbf490f18176b Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Wed, 12 Mar 2025 09:45:52 +0000 Subject: [PATCH 20/23] RHIDP-5570 - Document that the Dynamic Plugin cache PVC is disabled by default --- .../con-dynamic-plugins-cache.adoc | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index e6b3c7bca2..27ec53ea1c 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -13,12 +13,13 @@ When you enable dynamic plugins cache: == Enabling the dynamic plugins cache To enable the dynamic plugins cache in {product-very-short}, the plugins directory `dynamic-plugins-root` must be a persistent volume. -=== Creating a PVC for Dynamic Plugins Cache by using the Operator +=== Creating a PVC for the dynamic plugin cache by using the Operator For operator-based installations, you must manually create the persistent volume claim (PVC) by replacing the default `dynamic-plugins-root` volume with a PVC named `dynamic-plugins-root`. .Procedure . Create the persistent volume definition and save it to a file, for example `pvc.yaml`. For example: ++ [source,yaml] ---- kind: PersistentVolumeClaim @@ -32,7 +33,7 @@ spec: requests: storage: 5Gi ---- - ++ [NOTE] ==== This example uses `ReadWriteOnce` as the access mode which prevents multiple replicas from sharing the PVC across different nodes. @@ -41,6 +42,7 @@ To run multiple replicas on different nodes, depending on your storage driver, y ==== . To apply this PVC to your cluster, run the following command: ++ [source,terminal] ---- oc apply -f pvc.yaml @@ -66,14 +68,14 @@ spec: persistentVolumeClaim: claimName: dynamic-plugins-root ---- - ++ [NOTE] To avoid adding a new volume, you must use the `$patch: replace` directive. -=== Creating a PVC for Dynamic Plugins Cache using the Helm Chart +=== Creating a PVC for the dynamic plugin cache using the Helm Chart For Helm Chart installations, if you require the dynamic plugin cache to persist across pod restarts, you must create a PersistentVolumeClaim (PVC) and configure the Helm Chart to use it. -.Procedure +.Procedure . Create the persistent volume definition. For example: + [source,yaml] @@ -89,7 +91,7 @@ spec: requests: storage: 5Gi ---- - ++ [NOTE] ==== This example uses `ReadWriteOnce` as the access mode which prevents multiple replicas from sharing the PVC across different nodes. @@ -98,6 +100,7 @@ To run multiple replicas on different nodes, depending on your storage driver, y ==== . To apply this PVC to your cluster, run the following command: ++ [source,terminal] ---- oc apply -f pvc.yaml @@ -130,7 +133,7 @@ extraVolumes: - name: temp emptyDir: {} ---- - ++ [NOTE] ==== When you configure the Helm chart to use the PVC, you must also include the link:https://github.com/redhat-developer/rhdh-chart/blob/release-{product-version}/charts/backstage/values.yaml#L145-L181[`extraVolumes`] defined in the default Helm chart. From 0de62fdbe647ad33e2137ec017ab1e8e4e57a54c Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Thu, 13 Mar 2025 09:58:11 +0000 Subject: [PATCH 21/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 27ec53ea1c..cfb1f3fd62 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -73,7 +73,7 @@ spec: To avoid adding a new volume, you must use the `$patch: replace` directive. === Creating a PVC for the dynamic plugin cache using the Helm Chart -For Helm Chart installations, if you require the dynamic plugin cache to persist across pod restarts, you must create a PersistentVolumeClaim (PVC) and configure the Helm Chart to use it. +For Helm chart installations, if you require the dynamic plugin cache to persist across pod restarts, you must create a persistent volume claim (PVC) and configure the Helm chart to use it. .Procedure . Create the persistent volume definition. For example: From 98afcaca02f114d3644c2a664c51b260ebf15170 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Thu, 13 Mar 2025 10:00:56 +0000 Subject: [PATCH 22/23] Update con-dynamic-plugins-cache.adoc --- .../con-dynamic-plugins-cache.adoc | 48 ++++++++++--------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index cfb1f3fd62..862fd7afe7 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -109,29 +109,31 @@ oc apply -f pvc.yaml + [source,yaml] ---- -extraVolumes: - - name: dynamic-plugins-root - persistentVolumeClaim: - claimName: dynamic-plugins-root - - name: dynamic-plugins - configMap: - defaultMode: 420 - name: '{{ printf "%s-dynamic-plugins" .Release.Name }}' - optional: true - - name: dynamic-plugins-npmrc - secret: - defaultMode: 420 - optional: true - secretName: '{{ printf "%s-dynamic-plugins-npmrc" .Release.Name }}' - - name: dynamic-plugins-registry-auth - secret: - defaultMode: 416 - optional: true - secretName: '{{ printf "%s-dynamic-plugins-registry-auth" .Release.Name }}' - - name: npmcacache - emptyDir: {} - - name: temp - emptyDir: {} +upstream: + backstage: + extraVolumes: + - name: dynamic-plugins-root + persistentVolumeClaim: + claimName: dynamic-plugins-root + - name: dynamic-plugins + configMap: + defaultMode: 420 + name: '{{ printf "%s-dynamic-plugins" .Release.Name }}' + optional: true + - name: dynamic-plugins-npmrc + secret: + defaultMode: 420 + optional: true + secretName: '{{ printf "%s-dynamic-plugins-npmrc" .Release.Name }}' + - name: dynamic-plugins-registry-auth + secret: + defaultMode: 416 + optional: true + secretName: '{{ printf "%s-dynamic-plugins-registry-auth" .Release.Name }}' + - name: npmcacache + emptyDir: {} + - name: temp + emptyDir: {} ---- + [NOTE] From 17c102f9b35052b9a174fb3e29f2967a0fd9f177 Mon Sep 17 00:00:00 2001 From: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Date: Fri, 14 Mar 2025 18:39:58 +0000 Subject: [PATCH 23/23] Update modules/dynamic-plugins/con-dynamic-plugins-cache.adoc Co-authored-by: Lindsey Frazier --- modules/dynamic-plugins/con-dynamic-plugins-cache.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc index 862fd7afe7..56404e21b3 100644 --- a/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc +++ b/modules/dynamic-plugins/con-dynamic-plugins-cache.adoc @@ -18,7 +18,7 @@ For operator-based installations, you must manually create the persistent volume .Procedure -. Create the persistent volume definition and save it to a file, for example `pvc.yaml`. For example: +. Create the persistent volume definition and save it to a file, such as `pvc.yaml`. For example: + [source,yaml] ----