From 0fbe2ddf5aff21484a15468abe02524c84baa61d Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 28 Jan 2025 17:26:57 +0100 Subject: [PATCH 1/8] Update the config in installation --- .../proc-install-rhdh-ocp-operator.adoc | 42 +++++++++++++++++++ .../proc-install-rhdh-osd-gcp-operator.adoc | 42 +++++++++++++++++++ 2 files changed, 84 insertions(+) diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 54f6bd196e..311c52a55d 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -19,6 +19,48 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the . From the *Developer* perspective on the {ocp-short} web console, click *+Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. +. Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration using the following template: ++ +-- +[source,yaml,subs="attributes+"] +---- +apiVersion: v1 +kind: ConfigMap +metadata: + name: app-config-rhdh +data: + "app-config-rhdh.yaml": | + app: + title: {product} + baseUrl: https:// + backend: + auth: + externalAccess: + - type: legacy + options: + subject: legacy-default-config + secret: "${BACKEND_SECRET}" + baseUrl: https:// + cors: + origin: https:// +---- +-- + +. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: ++ +-- +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: Secret +metadata: + name: {my-product-secrets} +stringData: + # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup + BACKEND_SECRET: "xxx" +---- +-- + . Click *Create*. . xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. . On the *Create Backstage* page, click *Create* diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 995d878094..6029507bde 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -17,6 +17,48 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product . In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, click *Install*. . In the {ocp-short} console, navigate to *Installed Operators* and select *{product} Operator*. +. Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration using the following template: ++ +-- +[source,yaml,subs="attributes+"] +---- +apiVersion: v1 +kind: ConfigMap +metadata: + name: app-config-rhdh +data: + "app-config-rhdh.yaml": | + app: + title: {product} + baseUrl: https:// + backend: + auth: + externalAccess: + - type: legacy + options: + subject: legacy-default-config + secret: "${BACKEND_SECRET}" + baseUrl: https:// + cors: + origin: https:// +---- +-- + +. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: ++ +-- +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: Secret +metadata: + name: {my-product-secrets} +stringData: + # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup + BACKEND_SECRET: "xxx" +---- +-- + . From the {product-short} Operator page, click *Create New Instance* and specify the name and namespace where you want to deploy {product-short}. . Configure the required settings such as Git integration, secret management, and user permissions. . Review the configuration, select deployment options, and click *Create*. From 9034cf537d2d8de902fe14dba5e3997574a5e1cd Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 31 Jan 2025 15:27:38 +0100 Subject: [PATCH 2/8] Update the config in installation --- modules/installation/proc-install-rhdh-ocp-operator.adoc | 4 ++-- modules/installation/proc-install-rhdh-osd-gcp-operator.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 311c52a55d..746332c07e 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -19,7 +19,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the . From the *Developer* perspective on the {ocp-short} web console, click *+Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. -. Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration using the following template: +. Create a config map named `app-config-rhdh` containing the {product-short} configuration using the following template: + -- [source,yaml,subs="attributes+"] @@ -46,7 +46,7 @@ data: ---- -- -. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- [source,yaml,subs="+attributes,+quotes"] diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 6029507bde..05348c2334 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -17,7 +17,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product . In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, click *Install*. . In the {ocp-short} console, navigate to *Installed Operators* and select *{product} Operator*. -. Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration using the following template: +. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- [source,yaml,subs="attributes+"] @@ -44,7 +44,7 @@ data: ---- -- -. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- [source,yaml,subs="+attributes,+quotes"] From c39061875cb51b3eb98046a950a2dd6ac8aa449a Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 1 Aug 2025 14:53:49 +0200 Subject: [PATCH 3/8] Update the config in installation --- .../installation/proc-install-operator.adoc | 5 ++ .../proc-install-rhdh-ocp-operator.adoc | 36 +++++++----- .../proc-install-rhdh-osd-gcp-helm.adoc | 23 +++++++- .../proc-install-rhdh-osd-gcp-operator.adoc | 55 ++++++++++++++----- titles/install-rhdh-aks/master.adoc | 6 ++ titles/install-rhdh-eks/master.adoc | 6 ++ titles/install-rhdh-gke/master.adoc | 6 ++ titles/install-rhdh-ocp/master.adoc | 6 ++ titles/install-rhdh-osd-gcp/master.adoc | 5 ++ 9 files changed, 121 insertions(+), 27 deletions(-) diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index 6af2071eab..e06504e729 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -22,6 +22,11 @@ Containers are available for the following CPU architectures: . In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*. . In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, read the information about the Operator and click *Install* to open the *Install Operator* page. +. After the Operator is successfully installed, provision your custom configuration: ++ +Before you create a {product-short} instance, you must create the required config map and Secret resources in your project. These include the `baseUrl` and service-to-service authentication secrets. ++ +For detailed steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. . From the *Update channel* drop-down menu, select the update channel that you want to use, for example, *fast* or *fast-{product-version}*. + [IMPORTANT] diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 746332c07e..99d120488a 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -7,7 +7,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the *Developer Catalog* in the {ocp-brand-name} web console. This deployment method uses the {product} Operator. .Prerequisites - +* You have set the `baseUrl` in your `{my-app-config-file}` to match the external URL of your {product-short} instance. Without it, frontend and backend services cannot communicate, and features may not work as expected. * xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator]. * xref:{configuring-book-url}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. * xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. @@ -15,13 +15,11 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Procedure . In the {ocp-short} web console, select your `_<{my-product-namespace}>_` project. - -. From the *Developer* perspective on the {ocp-short} web console, click *+Add*. +. From the *Developer* perspective on the {ocp-short} web console, click *Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. -. Create a config map named `app-config-rhdh` containing the {product-short} configuration using the following template: +. Provision your custom configuration, using the following template: + --- [source,yaml,subs="attributes+"] ---- apiVersion: v1 @@ -32,7 +30,7 @@ data: "app-config-rhdh.yaml": | app: title: {product} - baseUrl: https:// + baseUrl: {my-product-url} backend: auth: externalAccess: @@ -40,11 +38,19 @@ data: options: subject: legacy-default-config secret: "${BACKEND_SECRET}" - baseUrl: https:// + baseUrl: {my-product-url} cors: - origin: https:// + origin: {my-product-url} ---- --- ++ +Use a config map named `app-config-rhdh` to provide your `app-config.yaml` file, and a Secret for service-to-service authentication (such as `BACKEND_SECRET`). ++ +To create and apply these configuration resources, follow the steps in xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration] for the full procedure. ++ +[NOTE] +==== +The `app-config-rhdh` config map must include your customized `app-config.yaml` file. This config map is mounted into the {product-short} container at runtime. +==== . Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + @@ -56,14 +62,18 @@ kind: Secret metadata: name: {my-product-secrets} stringData: - # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup - BACKEND_SECRET: "xxx" + # TODO: Add the necessary auth secrets for service-to-service auth setup + BACKEND_SECRET: "xxx" # Replace with your `Base64-encoded` secret ---- -- - ++ +[NOTE] +==== +Ensure that your secret includes `BACKEND_SECRET`, used for service-to-service authentication. For structure and provisioning steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +==== . Click *Create*. . xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. -. On the *Create Backstage* page, click *Create* +. On the *Create Backstage* page, click *Create*. .Verification diff --git a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc index df951f9169..ebddb9701c 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc @@ -17,7 +17,28 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product . In the *Filter by keyword* box, enter {product-short} and click the *{product}* card. . From the {product} page, click *Create*. . From your cluster, copy the {ocp-short} router host (for example: `apps..com`). -. Select the radio button to configure the {product-short} instance with either the form view or YAML view. The *Form view* is selected by default. +. Select the radio button to configure the {product-short} instance with either the form view or YAML view. ++ +[IMPORTANT] +==== +Before deploying {product-short} using the Helm chart, you must define custom configuration settings such as the public `baseUrl` for your instance. Without setting `baseUrl`, the application cannot function correctly. You can define this configuration either through the *Form view* or the *YAML view* in the Helm install wizard. + +To configure the `baseUrl`, set the following values in your Helm configuration: +[source,yaml] +---- +global: + app: + baseUrl: https:// + backend: + baseUrl: https:// + cors: + origin: https:// +---- +You can also define additional secrets, plugins, and advanced configuration in your `values.yaml` file. For full instructions, see: +xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +==== ++ +The *Form view* is selected by default. + -- .. Using *Form view* diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 05348c2334..2deae0fb63 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -13,11 +13,11 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Procedure -. In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*. -. In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card. +. In the *Administrator* perspective of the {ocp-short} web console, go to *Operators > OperatorHub*. +. In the *Filter by keyword* field, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, click *Install*. -. In the {ocp-short} console, navigate to *Installed Operators* and select *{product} Operator*. -. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. After the installation completes, navigate to *Installed Operators* and select *Red Hat Developer Hub Operator*. +. Provision your custom configuration: + -- [source,yaml,subs="attributes+"] @@ -30,7 +30,7 @@ data: "app-config-rhdh.yaml": | app: title: {product} - baseUrl: https:// + baseUrl: {my-product-url} backend: auth: externalAccess: @@ -38,12 +38,41 @@ data: options: subject: legacy-default-config secret: "${BACKEND_SECRET}" - baseUrl: https:// + baseUrl: {my-product-url} cors: - origin: https:// + origin: {my-product-url} +---- +-- ++ +You must create a config map named `app-config-rhdh` and a Kubernetes Secret containing the `BACKEND_SECRET`. These resources are used by the {product-short} instance for authentication and application settings. ++ +For further steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +. Create a config map named `app-config-rhdh` that includes your `{my-app-config-file}` as shown: ++ +-- +[source,yaml,subs="attributes+"] +---- +apiVersion: v1 +kind: ConfigMap +metadata: + name: app-config-rhdh +data: + "app-config-rhdh.yaml": | + app: + title: {product} + baseUrl: {my-product-url} + backend: + auth: + externalAccess: + - type: legacy + options: + subject: legacy-default-config + secret: "${BACKEND_SECRET}" + baseUrl: {my-product-url} + cors: + origin: {my-product-url} ---- -- - . Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- @@ -54,13 +83,13 @@ kind: Secret metadata: name: {my-product-secrets} stringData: - # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup - BACKEND_SECRET: "xxx" + # TODO: Add the necessary auth secrets for service-to-service auth setup + BACKEND_SECRET: "xxx" # Replace with your `Base64-encoded` secret ---- -- - -. From the {product-short} Operator page, click *Create New Instance* and specify the name and namespace where you want to deploy {product-short}. -. Configure the required settings such as Git integration, secret management, and user permissions. +. Return to the *Developer Hub Operator* page and click *Create New Instance*. +. Specify the name and target namespace for the {product-short} deployment. +. Configure required options such as Git integration, secrets, and user permissions. . Review the configuration, select deployment options, and click *Create*. .Verification diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc index d2022b0277..de50f16ec9 100644 --- a/titles/install-rhdh-aks/master.adoc +++ b/titles/install-rhdh-aks/master.adoc @@ -15,6 +15,12 @@ You can install {product} on {aks-brand-name} ({aks-short}) using one of the fol * The {product} Operator * The {product} Helm chart +[IMPORTANT] +==== +Set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). +This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. +==== + // Operator method include::modules/installation/proc-rhdh-deploy-aks-operator.adoc[leveloffset=+1] diff --git a/titles/install-rhdh-eks/master.adoc b/titles/install-rhdh-eks/master.adoc index ee13e7e19e..262bd819c2 100644 --- a/titles/install-rhdh-eks/master.adoc +++ b/titles/install-rhdh-eks/master.adoc @@ -15,6 +15,12 @@ You can install {product} on {eks-brand-name} ({eks-short}) using one of the fol * The {product} Operator * The {product} Helm chart +[IMPORTANT] +==== +You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). +This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. +==== + // Operator method include::assemblies/assembly-install-rhdh-eks-operator.adoc[leveloffset=+1] diff --git a/titles/install-rhdh-gke/master.adoc b/titles/install-rhdh-gke/master.adoc index deaf0f1f71..38222531ee 100644 --- a/titles/install-rhdh-gke/master.adoc +++ b/titles/install-rhdh-gke/master.adoc @@ -15,6 +15,12 @@ You can install {product} on {gke-brand-name} ({gke-short}) using one of the fol * The {product} Operator * The {product} Helm chart +[IMPORTANT] +==== +Set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). +This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. +==== + // Operator method include::modules/installation/proc-rhdh-deploy-gke-operator.adoc[leveloffset=+1] diff --git a/titles/install-rhdh-ocp/master.adoc b/titles/install-rhdh-ocp/master.adoc index 417a238360..3dfbad9ea0 100644 --- a/titles/install-rhdh-ocp/master.adoc +++ b/titles/install-rhdh-ocp/master.adoc @@ -27,6 +27,12 @@ The {product} Helm chart:: * Requires manual installation and management -- +[IMPORTANT] +==== +You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). +This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. +==== + Use the installation method that best meets your needs and preferences. .Additional resources diff --git a/titles/install-rhdh-osd-gcp/master.adoc b/titles/install-rhdh-osd-gcp/master.adoc index 09be5ae285..8d19b6ed89 100644 --- a/titles/install-rhdh-osd-gcp/master.adoc +++ b/titles/install-rhdh-osd-gcp/master.adoc @@ -12,6 +12,11 @@ You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) * The {product} Operator * The {product} Helm chart +[IMPORTANT] +==== +You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance. This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. +==== + // Operator procedure include::modules/installation/proc-install-rhdh-osd-gcp-operator.adoc[leveloffset=+1] From 8df95b55f571dd9efe4c193be9fcaaf3d21cadd7 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 1 Aug 2025 15:19:26 +0200 Subject: [PATCH 4/8] Update the config in installation --- .../installation/proc-install-rhdh-osd-gcp-operator.adoc | 4 ++-- titles/install-rhdh-aks/master.adoc | 6 ------ titles/install-rhdh-eks/master.adoc | 6 ------ titles/install-rhdh-gke/master.adoc | 6 ------ 4 files changed, 2 insertions(+), 20 deletions(-) diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 2deae0fb63..b5836a8898 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -16,7 +16,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product . In the *Administrator* perspective of the {ocp-short} web console, go to *Operators > OperatorHub*. . In the *Filter by keyword* field, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, click *Install*. -. After the installation completes, navigate to *Installed Operators* and select *Red Hat Developer Hub Operator*. +. After the installation completes, navigate to *Installed Operators* and select *Red Hat {product-short} Operator*. . Provision your custom configuration: + -- @@ -87,7 +87,7 @@ stringData: BACKEND_SECRET: "xxx" # Replace with your `Base64-encoded` secret ---- -- -. Return to the *Developer Hub Operator* page and click *Create New Instance*. +. Return to the *{product-short} Operator* page and click *Create New Instance*. . Specify the name and target namespace for the {product-short} deployment. . Configure required options such as Git integration, secrets, and user permissions. . Review the configuration, select deployment options, and click *Create*. diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc index de50f16ec9..d2022b0277 100644 --- a/titles/install-rhdh-aks/master.adoc +++ b/titles/install-rhdh-aks/master.adoc @@ -15,12 +15,6 @@ You can install {product} on {aks-brand-name} ({aks-short}) using one of the fol * The {product} Operator * The {product} Helm chart -[IMPORTANT] -==== -Set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). -This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. -==== - // Operator method include::modules/installation/proc-rhdh-deploy-aks-operator.adoc[leveloffset=+1] diff --git a/titles/install-rhdh-eks/master.adoc b/titles/install-rhdh-eks/master.adoc index 262bd819c2..ee13e7e19e 100644 --- a/titles/install-rhdh-eks/master.adoc +++ b/titles/install-rhdh-eks/master.adoc @@ -15,12 +15,6 @@ You can install {product} on {eks-brand-name} ({eks-short}) using one of the fol * The {product} Operator * The {product} Helm chart -[IMPORTANT] -==== -You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). -This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. -==== - // Operator method include::assemblies/assembly-install-rhdh-eks-operator.adoc[leveloffset=+1] diff --git a/titles/install-rhdh-gke/master.adoc b/titles/install-rhdh-gke/master.adoc index 38222531ee..deaf0f1f71 100644 --- a/titles/install-rhdh-gke/master.adoc +++ b/titles/install-rhdh-gke/master.adoc @@ -15,12 +15,6 @@ You can install {product} on {gke-brand-name} ({gke-short}) using one of the fol * The {product} Operator * The {product} Helm chart -[IMPORTANT] -==== -Set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). -This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. -==== - // Operator method include::modules/installation/proc-rhdh-deploy-gke-operator.adoc[leveloffset=+1] From 2ce3e806666d71f737e2044c8781b30e8da707c3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 5 Aug 2025 13:44:15 +0200 Subject: [PATCH 5/8] Update the config in installation --- modules/installation/proc-install-rhdh-ocp-operator.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 99d120488a..8f844b55b4 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -7,7 +7,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the *Developer Catalog* in the {ocp-brand-name} web console. This deployment method uses the {product} Operator. .Prerequisites -* You have set the `baseUrl` in your `{my-app-config-file}` to match the external URL of your {product-short} instance. Without it, frontend and backend services cannot communicate, and features may not work as expected. +* You have set the `baseUrl` in your `{my-app-config-file}` to match the external URL of your {product-short} instance. Without it, frontend and backend services cannot communicate, and features might not work as expected. * xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator]. * xref:{configuring-book-url}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. * xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. @@ -18,7 +18,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the . From the *Developer* perspective on the {ocp-short} web console, click *Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. -. Provision your custom configuration, using the following template: +. Provision your custom configuration using the following template: + [source,yaml,subs="attributes+"] ---- @@ -52,7 +52,7 @@ To create and apply these configuration resources, follow the steps in xref:{con The `app-config-rhdh` config map must include your customized `app-config.yaml` file. This config map is mounted into the {product-short} container at runtime. ==== -. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value, as shown in the following example: + -- [source,yaml,subs="+attributes,+quotes"] From 908f5b2613300a1daa7419343b37e17922eaaf69 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 5 Aug 2025 14:18:13 +0200 Subject: [PATCH 6/8] Update the config in installation --- modules/installation/proc-install-rhdh-ocp-operator.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 8f844b55b4..40f7147f34 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -14,8 +14,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Procedure -. In the {ocp-short} web console, select your `_<{my-product-namespace}>_` project. -. From the *Developer* perspective on the {ocp-short} web console, click *Add*. +. In the {ocp-short} web console, select your `_<{my-product-namespace}>_` project, then click *Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. . Provision your custom configuration using the following template: From cf65c84d801437995ea2e66218e79574b118acb6 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 5 Aug 2025 14:26:43 +0200 Subject: [PATCH 7/8] Update the config in installation --- modules/installation/proc-install-operator.adoc | 2 +- modules/installation/proc-install-rhdh-osd-gcp-operator.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index e06504e729..02c0e58f1b 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -19,7 +19,7 @@ Containers are available for the following CPU architectures: .Procedure -. In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*. +. In the navigation menu of the {ocp-short} console, click *Operators > OperatorHub*. . In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, read the information about the Operator and click *Install* to open the *Install Operator* page. . After the Operator is successfully installed, provision your custom configuration: diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index b5836a8898..0f3e392f99 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -13,7 +13,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Procedure -. In the *Administrator* perspective of the {ocp-short} web console, go to *Operators > OperatorHub*. +. In the {ocp-short} web console menu, go to *Operators > OperatorHub*. . In the *Filter by keyword* field, enter {product-short} and click the *{product} Operator* card. . On the *{product} Operator* page, click *Install*. . After the installation completes, navigate to *Installed Operators* and select *Red Hat {product-short} Operator*. From d836f4f41f828bf820f95650a688da03bc2ce6ac Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 6 Aug 2025 16:56:35 +0200 Subject: [PATCH 8/8] Update the config in installation --- modules/installation/proc-install-rhdh-ocp-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 40f7147f34..56e24b8c1a 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -14,7 +14,7 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Procedure -. In the {ocp-short} web console, select your `_<{my-product-namespace}>_` project, then click *Add*. +. In the {ocp-short} web console, select your `_<{my_product_namespace}>_` project, then click *Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. . Provision your custom configuration using the following template: