Skip to content

Commit 2b4dea9

Browse files
GitHub Actionsjmagak
authored andcommitted
Move links in Prerequisites to Additional resources-Configuring
1 parent 1e4feaf commit 2b4dea9

8 files changed

+54
-11
lines changed

modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de
55

66
.Prerequisites
77

8-
* 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].
8+
* You are using a supported version of PostgreSQL.
99
* You have the following details:
1010
** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address
1111
** `db-port`: Denotes your PostgreSQL instance port number, such as `5432`
@@ -160,3 +160,8 @@ upstream:
160160
----
161161
helm upgrade -n <your-namespace> <your-deploy-name> openshift-helm-charts/redhat-developer-hub -f values.yaml --version {product-chart-version}
162162
----
163+
164+
[role="_additional-resources"]
165+
.Additional resources
166+
167+
* link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]

modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can configure an external PostgreSQL instance using the {product} Operator.
55

66
.Prerequisites
77

8-
* 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].
8+
* You are using a supported version of PostgreSQL.
99
* You have the following details:
1010
** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address
1111
** `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
107107
====
108108

109109
. Apply the `{product-custom-resource-type}` CR to the namespace where you have deployed the {product-short} instance.
110+
111+
[role="_additional-resources"]
112+
.Additional resources
113+
114+
* link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]

modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following procedure uses a database copy script to do a quick migration.
1010

1111
.Prerequisites
1212

13-
* 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.
13+
* You have installed the `pg_dump` and `psql` utilities on your local machine.
1414
* For data export, you have the PGSQL user privileges to make a full dump of local databases.
1515
* For data import, you have the PGSQL admin privileges to create an external database and populate it with database dumps.
1616

@@ -127,3 +127,9 @@ oc get pods -n <your-namespace>
127127
* The `backstage-psql-developer-hub-0` pod is not available.
128128
+
129129
You can also verify these details using the *Topology* view in the {ocp-short} web console.
130+
131+
[role="_additional-resources"]
132+
.Additional resources
133+
134+
* link:https://www.postgresql.org/docs/current/app-pgdump.html[`pg_dump`]
135+
* link:https://www.postgresql.org/docs/current/app-psql.html[`psql`]

modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Configured plugins in {product-short} receive dedicated cache connections, which
88
.Prerequisites
99
* You have installed {product}.
1010
* You have an active Redis server.
11-
For more information on setting up an external Redis server, see the link:https://www.redis.io/docs/latest/[`official Redis documentation`].
1211

1312
.Procedure
1413
. 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:
3534

3635
TIP: Optionally, enable the cache for unsupported plugins that support this feature.
3736
See their respective documentation for details.
37+
38+
[role="_additional-resources"]
39+
.Additional resources
40+
41+
* link:https://www.redis.io/docs/latest/[Setting up an external Redis server]

modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `mountPath` field specifies the location where a ConfigMap or Secret is moun
1818

1919
.Prerequisites
2020
* You have developer permissions to access the {ocp-short} cluster containing your {product-short} instance using the {openshift-cli}.
21-
* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}].
21+
* Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}.
2222

2323
.Procedure
2424

@@ -80,3 +80,8 @@ spec:
8080
====
8181
`_<my_product_secrets>_` is your preferred {product-short} secret name, specifying the identifier for your secret configuration within {product-short}.
8282
====
83+
84+
[role="_additional-resources"]
85+
.Additional resources
86+
87+
* link:{installing-on-ocp-book-url}[Installing the {product} Operator in {ocp-short}]

modules/configuring/proc-provisioning-your-custom-configuration.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Your changes on this configuration might get reverted on {product-short} restart
1010
====
1111

1212
.Prerequisites
13-
* 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.
13+
* By using the {openshift-cli}, you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
1414

1515
.Procedure
1616
. Author your custom `_<my_product_secrets>_.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:
101101
* To enable dynamic plugins, link:{installing-and-viewing-plugins-book-url}[provision your dynamic plugins config map].
102102

103103
* To configure authorization by using external files, link:{authorization-book-url}#managing-authorizations-by-using-external-files[provision your RBAC policies config map].
104+
105+
[role="_additional-resources"]
106+
.Additional resources
107+
108+
* 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]

modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ You can use the {product} Helm chart to add a custom application configuration f
55

66
.Prerequisites
77

8-
* 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.
9-
* xref:provisioning-your-custom-configuration[You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project].
8+
* 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.
9+
* You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project.
1010

1111
.Procedure
1212

@@ -29,3 +29,9 @@ upstream:
2929

3030
.Next steps
3131
* Install {product-short} by using Helm.
32+
33+
[role="_additional-resources"]
34+
.Additional resources
35+
36+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-short} project]
37+
* xref:provisioning-your-custom-configuration[Uploading your custom configuration files and secrets in your `_<{my-product-namespace}>_` project]

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ To use the {product-short} Operator to run {product} with your custom configurat
77
* Injects environment variables provisioned in your custom secrets.
88

99
.Prerequisites
10-
* 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.
11-
* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}].
12-
* xref:provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project].
10+
* By using the {openshift-cli}, you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
11+
* Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}.
12+
* You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project.
1313

1414
.Procedure
1515

@@ -207,3 +207,10 @@ Optionally, xref:configuring-the-deployment[enter your deployment configuration]
207207
----
208208
$ oc apply --filename={my-product-cr-name}.yaml --namespace={my-product-namespace}
209209
----
210+
211+
[role="_additional-resources"]
212+
.Additional resources
213+
214+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-short} project]
215+
* link:{installing-on-ocp-book-url}[Installing the {product} Operator in {ocp-short}]
216+
* xref:provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]

0 commit comments

Comments
 (0)