From f15f57fb8bd8dee4cb33192b71d372b477cd6d1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 24 Apr 2025 11:26:01 +0200 Subject: [PATCH 01/13] RHIDP-6571 RHIDP-6174 - on Operator-based deployments configuring the base URL is no longer required MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...rovisioning-your-custom-configuration.adoc | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index b55374b737..a5226ed3b6 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -20,8 +20,11 @@ It contains one secret per line in `KEY=value` form. . Author your custom `{my-app-config-file}` file. This is the main {product-short} configuration file. -+ -The `baseUrl` field is mandatory in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. You must specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. + +** To prepare a deployment with the {product} Operator, you can start with an empty file. + +** To prepare a deployment with the {product} Helm chart, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. +Specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. + .Configuring the `baseUrl` in `{my-app-config-file}` ==== @@ -43,13 +46,13 @@ backend: origin: {my-product-url} ---- ==== -+ -Optionally, enter your configuration such as: -* link:{authentication-book-url}[{authentication-book-title}]. -* link:{authorization-book-url}[{authorization-book-title}]. -* link:{customizing-book-url}[Customization]. -* xref:proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_running-behind-a-proxy[Configure your {ocp-short} integration]. +** Optionally, enter your configuration such as: + +*** link:{authentication-book-url}[{authentication-book-title}]. +*** link:{authorization-book-url}[{authorization-book-title}]. +*** link:{customizing-book-url}[Customization]. +*** xref:proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_running-behind-a-proxy[Configure your {ocp-short} integration]. . Provision your custom configuration files to your {ocp-short} cluster. From 42ca7a6597eb6b3018e4623f4c7d49b1e46b2ed0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 24 Apr 2025 11:30:42 +0200 Subject: [PATCH 02/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index a5226ed3b6..6f1478835b 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -21,7 +21,7 @@ It contains one secret per line in `KEY=value` form. . Author your custom `{my-app-config-file}` file. This is the main {product-short} configuration file. -** To prepare a deployment with the {product} Operator, you can start with an empty file. +** To prepare a deployment with the {product} Operator on OpenShift, you can start with an empty file. ** To prepare a deployment with the {product} Helm chart, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. Specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. From b369d7d894e1fe216c93f97411981f717f2d3767 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 24 Apr 2025 11:31:07 +0200 Subject: [PATCH 03/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 6f1478835b..5af7ebae0b 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -23,7 +23,7 @@ This is the main {product-short} configuration file. ** To prepare a deployment with the {product} Operator on OpenShift, you can start with an empty file. -** To prepare a deployment with the {product} Helm chart, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. +** To prepare a deployment with the {product} Helm chart, or on Kubernetes, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. Specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. + .Configuring the `baseUrl` in `{my-app-config-file}` From 01f7d942a400b89e7faedfb5baf2bbefb1372785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 24 Apr 2025 12:20:09 +0200 Subject: [PATCH 04/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../configuring/proc-provisioning-your-custom-configuration.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 5af7ebae0b..2d112503dc 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -22,6 +22,7 @@ It contains one secret per line in `KEY=value` form. This is the main {product-short} configuration file. ** To prepare a deployment with the {product} Operator on OpenShift, you can start with an empty file. +Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. Specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. From c498862f72265670aa2a30ded4aaa1735a6a8d15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 28 Apr 2025 11:52:18 +0200 Subject: [PATCH 05/13] Applying suggestions --- .../proc-provisioning-your-custom-configuration.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 2d112503dc..824c42e804 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -24,8 +24,8 @@ This is the main {product-short} configuration file. ** To prepare a deployment with the {product} Operator on OpenShift, you can start with an empty file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. -** To prepare a deployment with the {product} Helm chart, or on Kubernetes, add the `baseUrl` field in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. -Specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization. +** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields your `{my-app-config-file}` file to ensure proper functionality of {product-short}. +The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backernd.cors` subsection: + .Configuring the `baseUrl` in `{my-app-config-file}` ==== From faa5461ca8ea54eb8f16f9b8df135dcb5e6a34cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 28 Apr 2025 11:54:38 +0200 Subject: [PATCH 06/13] Fixes https://issues.redhat.com/browse/RHIDP-6670 --- .../proc-provisioning-your-custom-configuration.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 824c42e804..aafef2c2a4 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -25,7 +25,8 @@ This is the main {product-short} configuration file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields your `{my-app-config-file}` file to ensure proper functionality of {product-short}. -The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backernd.cors` subsection: +The base URL is be what the user see in their browser when accessing {product-short}. +The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backend.cors` subsection: + .Configuring the `baseUrl` in `{my-app-config-file}` ==== From c3a49cb481e6a200cef50b36a534a97e4ca9f102 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:25:43 +0200 Subject: [PATCH 07/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index aafef2c2a4..c9d2f8a991 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -21,7 +21,7 @@ It contains one secret per line in `KEY=value` form. . Author your custom `{my-app-config-file}` file. This is the main {product-short} configuration file. -** To prepare a deployment with the {product} Operator on OpenShift, you can start with an empty file. +** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields your `{my-app-config-file}` file to ensure proper functionality of {product-short}. From 73a8d6da7da553dc7179823c78c49e7ec166a774 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:28:31 +0200 Subject: [PATCH 08/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index c9d2f8a991..45f6378727 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -24,7 +24,7 @@ This is the main {product-short} configuration file. ** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. -** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields your `{my-app-config-file}` file to ensure proper functionality of {product-short}. +** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. The base URL is be what the user see in their browser when accessing {product-short}. The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backend.cors` subsection: + From 322391b745721d873df14d1fc879b4bb7f399f54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:28:41 +0200 Subject: [PATCH 09/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc Co-authored-by: Priyanka Abel --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 45f6378727..530e3afc8a 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -25,7 +25,7 @@ This is the main {product-short} configuration file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. -The base URL is be what the user see in their browser when accessing {product-short}. +The base URL is what the user sees in their browser when accessing {product-short}. The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backend.cors` subsection: + .Configuring the `baseUrl` in `{my-app-config-file}` From a1ee92d79e18b3a4498042f610112cc84cf9b75a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:28:59 +0200 Subject: [PATCH 10/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc Co-authored-by: Lindsey Frazier --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 530e3afc8a..5a8d5e66c0 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -26,7 +26,7 @@ Creating a custom file, even an empty one, is required to avoid the {product} Op ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. The base URL is what the user sees in their browser when accessing {product-short}. -The relevant fields are `baseUrl` in the `app` and `backend` section, and `origin` in the `backend.cors` subsection: +The relevant fields are `baseUrl` in the `app` and `backend` sections, and `origin` in the `backend.cors` subsection: + .Configuring the `baseUrl` in `{my-app-config-file}` ==== From b40f832d0e0d1bcf521e33a0e5c02a7cc655f26a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:40:10 +0200 Subject: [PATCH 11/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 5a8d5e66c0..8fc6b1dc53 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -20,6 +20,8 @@ It contains one secret per line in `KEY=value` form. . Author your custom `{my-app-config-file}` file. This is the main {product-short} configuration file. +You need a custom `{my-app-config-file}` file to avoid the {product-short} installer to revert user edits during upgrades. +When your custom `{my-app-config-file}` file is empty, {product-short} is using default values. ** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. From 140e3d14ea6463c12c8a2227b261c9a25c1f7cad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:40:34 +0200 Subject: [PATCH 12/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../configuring/proc-provisioning-your-custom-configuration.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index 8fc6b1dc53..b108959e9a 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -24,7 +24,6 @@ You need a custom `{my-app-config-file}` file to avoid the {product-short} insta When your custom `{my-app-config-file}` file is empty, {product-short} is using default values. ** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. -Creating a custom file, even an empty one, is required to avoid the {product} Operator to revert user edits during upgrades. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. The base URL is what the user sees in their browser when accessing {product-short}. From 7d24897a795dce583137933d52b90880d21c20d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 30 Apr 2025 14:42:03 +0200 Subject: [PATCH 13/13] Update modules/configuring/proc-provisioning-your-custom-configuration.adoc --- .../proc-provisioning-your-custom-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index b108959e9a..f4f41608fe 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -26,7 +26,7 @@ When your custom `{my-app-config-file}` file is empty, {product-short} is using ** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. -The base URL is what the user sees in their browser when accessing {product-short}. +The base URL is what a {product-short} user sees in their browser when accessing {product-short}. The relevant fields are `baseUrl` in the `app` and `backend` sections, and `origin` in the `backend.cors` subsection: + .Configuring the `baseUrl` in `{my-app-config-file}`