From 2b4dea9898d5ece8c9500ec169a921dfbca5a87c Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 1 Jul 2025 20:35:21 +0300 Subject: [PATCH] Move links in Prerequisites to Additional resources-Configuring --- ...-configuring-postgresql-instance-using-helm.adoc | 7 ++++++- ...ring-postgresql-instance-using-the-operator.adoc | 7 ++++++- ...c-migrating-databases-to-an-external-server.adoc | 8 +++++++- .../proc-enabling-the-rhdh-plugin-assets-cache.adoc | 6 +++++- ...ur-custom-configuration-using-rhdh-operator.adoc | 7 ++++++- ...proc-provisioning-your-custom-configuration.adoc | 7 ++++++- ...-to-run-rhdh-with-your-custom-configuration.adoc | 10 ++++++++-- ...-to-run-rhdh-with-your-custom-configuration.adoc | 13 ++++++++++--- 8 files changed, 54 insertions(+), 11 deletions(-) diff --git a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc index 43a64c671f..2a2ff55c56 100644 --- a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc +++ b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc @@ -5,7 +5,7 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de .Prerequisites -* You are using a supported version of PostgreSQL. For more information, see the link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]. +* You are using a supported version of PostgreSQL. * You have the following details: ** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address ** `db-port`: Denotes your PostgreSQL instance port number, such as `5432` @@ -160,3 +160,8 @@ upstream: ---- helm upgrade -n openshift-helm-charts/redhat-developer-hub -f values.yaml --version {product-chart-version} ---- + +[role="_additional-resources"] +.Additional resources + +* link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page] \ No newline at end of file diff --git a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc index 53f8b0d12b..921c11e29e 100644 --- a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc +++ b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc @@ -5,7 +5,7 @@ You can configure an external PostgreSQL instance using the {product} Operator. .Prerequisites -* You are using a supported version of PostgreSQL. For more information, see the link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]. +* You are using a supported version of PostgreSQL. * You have the following details: ** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address ** `db-port`: Denotes your PostgreSQL instance port number, such as `5432` @@ -107,3 +107,8 @@ The environment variables listed in the `Backstage` CR work with the Operator de ==== . Apply the `{product-custom-resource-type}` CR to the namespace where you have deployed the {product-short} instance. + +[role="_additional-resources"] +.Additional resources + +* link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page] \ No newline at end of file diff --git a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc index 8724519039..8fe57b58fc 100644 --- a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc +++ b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc @@ -10,7 +10,7 @@ The following procedure uses a database copy script to do a quick migration. .Prerequisites -* You have installed the link:https://www.postgresql.org/docs/current/app-pgdump.html[`pg_dump`] and link:https://www.postgresql.org/docs/current/app-psql.html[`psql`] utilities on your local machine. +* You have installed the `pg_dump` and `psql` utilities on your local machine. * For data export, you have the PGSQL user privileges to make a full dump of local databases. * For data import, you have the PGSQL admin privileges to create an external database and populate it with database dumps. @@ -127,3 +127,9 @@ oc get pods -n * The `backstage-psql-developer-hub-0` pod is not available. + You can also verify these details using the *Topology* view in the {ocp-short} web console. + +[role="_additional-resources"] +.Additional resources + +* link:https://www.postgresql.org/docs/current/app-pgdump.html[`pg_dump`] +* link:https://www.postgresql.org/docs/current/app-psql.html[`psql`] \ No newline at end of file diff --git a/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc b/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc index add80975a4..1ea4566c24 100644 --- a/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc +++ b/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc @@ -8,7 +8,6 @@ Configured plugins in {product-short} receive dedicated cache connections, which .Prerequisites * You have installed {product}. * You have an active Redis server. -For more information on setting up an external Redis server, see the link:https://www.redis.io/docs/latest/[`official Redis documentation`]. .Procedure . Enable the {product-short} cache by defining Redis as the cache store type and entering your Redis server connection URL in your `{my-app-config-file}` file. @@ -35,3 +34,8 @@ techdocs: TIP: Optionally, enable the cache for unsupported plugins that support this feature. See their respective documentation for details. + +[role="_additional-resources"] +.Additional resources + +* link:https://www.redis.io/docs/latest/[Setting up an external Redis server] \ No newline at end of file diff --git a/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc b/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc index 8508c9f3a6..b65959df30 100644 --- a/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc +++ b/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc @@ -18,7 +18,7 @@ The `mountPath` field specifies the location where a ConfigMap or Secret is moun .Prerequisites * You have developer permissions to access the {ocp-short} cluster containing your {product-short} instance using the {openshift-cli}. -* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. +* Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}. .Procedure @@ -80,3 +80,8 @@ spec: ==== `__` is your preferred {product-short} secret name, specifying the identifier for your secret configuration within {product-short}. ==== + +[role="_additional-resources"] +.Additional resources + +* link:{installing-on-ocp-book-url}[Installing the {product} Operator in {ocp-short}] \ No newline at end of file diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index f4f41608fe..87b8569c85 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -10,7 +10,7 @@ Your changes on this configuration might get reverted on {product-short} restart ==== .Prerequisites -* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. +* By using the {openshift-cli}, you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. .Procedure . Author your custom `__.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files. @@ -101,3 +101,8 @@ Consider provisioning additional config maps and secrets: * To enable dynamic plugins, link:{installing-and-viewing-plugins-book-url}[provision your dynamic plugins config map]. * To configure authorization by using external files, link:{authorization-book-url}#managing-authorizations-by-using-external-files[provision your RBAC policies config map]. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli} developer commands] \ No newline at end of file diff --git a/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc index f99c95e2ce..a429a04875 100644 --- a/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc +++ b/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc @@ -5,8 +5,8 @@ You can use the {product} Helm chart to add a custom application configuration f .Prerequisites -* By using the {ocp-short} web console, you have access with developer permissions, to link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[an {ocp-short} project] named _<{my-product-namespace}>_, aimed at containing your {product-short} instance. -* xref:provisioning-your-custom-configuration[You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project]. +* By using the {ocp-short} web console, you have access with developer permissions, to an {ocp-short} project named _<{my-product-namespace}>_, aimed at containing your {product-short} instance. +* You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project. .Procedure @@ -29,3 +29,9 @@ upstream: .Next steps * Install {product-short} by using Helm. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-short} project] +* xref:provisioning-your-custom-configuration[Uploading your custom configuration files and secrets in your `_<{my-product-namespace}>_` project] \ No newline at end of file diff --git a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc index 09bf27c879..43804ca423 100644 --- a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc +++ b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc @@ -7,9 +7,9 @@ To use the {product-short} Operator to run {product} with your custom configurat * Injects environment variables provisioned in your custom secrets. .Prerequisites -* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. -* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. -* xref:provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. +* By using the {openshift-cli}, you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. +* Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}. +* You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project. .Procedure @@ -207,3 +207,10 @@ Optionally, xref:configuring-the-deployment[enter your deployment configuration] ---- $ oc apply --filename={my-product-cr-name}.yaml --namespace={my-product-namespace} ---- + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-short} project] +* link:{installing-on-ocp-book-url}[Installing the {product} Operator in {ocp-short}] +* xref:provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]