Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -160,3 +160,8 @@ upstream:
----
helm upgrade -n <your-namespace> <your-deploy-name> 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]
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -127,3 +127,9 @@ oc get pods -n <your-namespace>
* 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`]
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -80,3 +80,8 @@ spec:
====
`_<my_product_secrets>_` 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}]
Original file line number Diff line number Diff line change
Expand Up @@ -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 `_<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.
Expand Down Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]