From 67f729d1e8977889c857e9006c403fcb31d7a89d Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 20 Aug 2025 21:56:24 +0200 Subject: [PATCH 01/13] Apply Gennady's suggestions --- .../assembly-install-rhdh-orchestrator.adoc | 2 +- ...c => proc-enable-orchestrator-plugin.adoc} | 52 +++++++++---------- ...ll-components-for-orchestrator-plugin.adoc | 2 +- 3 files changed, 26 insertions(+), 30 deletions(-) rename modules/orchestrator/{proc-install-orchestrator-plugin.adoc => proc-enable-orchestrator-plugin.adoc} (50%) diff --git a/assemblies/assembly-install-rhdh-orchestrator.adoc b/assemblies/assembly-install-rhdh-orchestrator.adoc index 6a73c01b1a..237951525b 100644 --- a/assemblies/assembly-install-rhdh-orchestrator.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator.adoc @@ -15,7 +15,7 @@ To install {product}, use one of the following methods: * The {product} Helm chart // {product} Operator -include::modules/orchestrator/proc-install-orchestrator-plugin.adoc[leveloffset=+1] +include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] // {product} Helm chart include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] diff --git a/modules/orchestrator/proc-install-orchestrator-plugin.adoc b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc similarity index 50% rename from modules/orchestrator/proc-install-orchestrator-plugin.adoc rename to modules/orchestrator/proc-enable-orchestrator-plugin.adoc index 5572f55735..8e0caec4e8 100644 --- a/modules/orchestrator/proc-install-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-install-orchestrator-plugin_{context}"] -= Installing the Orchestrator plugin using Operator +[id="proc-enable-orchestrator-plugin_{context}"] += Enabling the Orchestrator plugin using Operator You can enable the Orchestrator plugin in {product-very-short} by configuring dynamic plugins in your {product-custom-resource-type} custom resource (CR). @@ -9,31 +9,27 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy * You have access to edit or create ConfigMaps in the namespace where the {product-custom-resource-type} CR is deployed. .Procedure -. Identify the Orchestrator plugin dynamic plugins that are included by default in the default `dynamic-plugins.yaml` file of the `install-dynamic-plugins` container: -+ -* `@redhat/backstage-plugin-orchestrator` (frontend) -* `@redhat/backstage-plugin-orchestrator-backend-dynamic` (backend) -* `@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic` -* `@redhat/backstage-plugin-orchestrator-form-widgets` -. To enable the Orchestrator plugin, update the ConfigMap file with the following data: -+ -[source,yaml,subs="+attributes,+quotes"] +. To enable the Orchestrator plugin with default settings, set `disabled: false` for the package. For example, `package: "@redhat/backstage-plugin-orchestrator@` is set to `disabled: false`: + +[source,yaml] ---- - includes: - - dynamic-plugins.default.yaml - plugins: - - package: "@redhat/backstage-plugin-orchestrator@1.6.0" - disabled: false - - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.6.0" - disabled: false - dependencies: - - ref: sonataflow - - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.6.0" - disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form-widgets@${ORCHESTRATOR_PLUGIN_VERSION}" - disabled: false +- package: "@redhat/backstage-plugin-orchestrator@" + disabled: false + integrity: sha512-fOSJv2PgtD2urKwBM7p9W6gV/0UIHSf4pkZ9V/wQO0eg0Zi5Mys/CL1ba3nO9x9l84MX11UBZ2r7PPVJPrmOtw== + pluginConfig: + dynamicPlugins: + frontend: + red-hat-developer-hub.backstage-plugin-orchestrator: + appIcons: + - importName: OrchestratorIcon + name: orchestratorIcon + dynamicRoutes: + - importName: OrchestratorPage + menuItem: + icon: orchestratorIcon + text: Orchestrator + path: /orchestrator ---- .Example: Complete configuration of the Orchestrator plugin @@ -48,15 +44,15 @@ data: includes: - dynamic-plugins.default.yaml plugins: - - package: "@redhat/backstage-plugin-orchestrator@1.6.0" + - package: "@redhat/backstage-plugin-orchestrator@" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.6.0" + - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@" disabled: false dependencies: - ref: sonataflow - - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.6.0" + - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.6.0" + - package: "@redhat/backstage-plugin-orchestrator-form-widgets@" disabled: false --- apiVersion: rhdh.redhat.com/v1alpha3 diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 934b71eeec..aabdb8373b 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -15,7 +15,7 @@ To run the Orchestrator plugin successfully on {ocp-short}, you must install com + [NOTE] ==== -The {product} Operator provisions these components automatically. Alternatively, you can install them manually by using another Operator. +You must preinstall the components, or install them by using one of the supported methods described below (manual installation, helper script, or Helm chart). ==== .Procedure From ad66f809b780bd25a54cfc8a8e749ee98bdf2a48 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 20 Aug 2025 23:18:02 +0200 Subject: [PATCH 02/13] Apply suggestions --- assemblies/assembly-orchestrator-rhdh.adoc | 6 +++--- ...chestrator-plugin-dependencies-operator.adoc} | 4 ++-- ...stall-components-for-orchestrator-plugin.adoc | 16 ++++++++-------- 3 files changed, 13 insertions(+), 13 deletions(-) rename modules/orchestrator/{con-orchestrator-plugin-dependencies.adoc => con-understanding-orchestrator-plugin-dependencies-operator.adoc} (95%) diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index cf3d1497e9..6956a6c6c4 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -17,20 +17,20 @@ You can streamline and automate your work by using the Orchestrator in {product} [NOTE] ==== -Orchestrator currently supports only {ocp-short}; it is not available on AKS, EKS, or GKE. +Orchestrator currently supports only {ocp-brand-name} ({ocp-short}); it is not available on {aks-brand-name} ({aks-short}), {eks-brand-name} ({eks-short}), or {gke-brand-name} ({gke-short}). ==== To start using Orchestrator in {product-very-short}, you must: * Install the required infrastructure components, such as Red Hat OpenShift Serverless Operator, Knative Serving, Knative Eventing, and OpenShift Serverless Logic Operator -* Configure your {product-custom-resource-type} custom resource (CR) for Orchestrator +* Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator * Import the Orchestrator software templates into the {product} catalog // orchestrator architecture include::modules/orchestrator/con-supported-architecture-for-orchestrator.adoc[leveloffset=+1] // provisioning plugin dependencies -include::modules/orchestrator/con-orchestrator-plugin-dependencies.adoc[leveloffset=+1] +include::modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1] // installing the components for the orchestrator plugin include::modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/orchestrator/con-orchestrator-plugin-dependencies.adoc b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc similarity index 95% rename from modules/orchestrator/con-orchestrator-plugin-dependencies.adoc rename to modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc index 5aaad9b7e1..182b0145cd 100644 --- a/modules/orchestrator/con-orchestrator-plugin-dependencies.adoc +++ b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-orchestrator-plugin-dependencies_{context}"] -= Orchestrator Plugin dependencies +[id="con-understanding-orchestrator-plugin-dependencies-operator_{context}"] += Understanding Orchestrator plugin dependencies for Operator installation The Orchestrator plugin in {product-very-short} requires components such as SonataFlow and supporting network policies to run. When you enable the plugin in your {product-custom-resource-type} custom resource (CR), the Operator automatically provisions these dependencies for you: diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index aabdb8373b..702eabd171 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -45,16 +45,11 @@ For more information on preparing the required infrastructure, see link:https:// * Install the OpenShift Serverless Logic Operator .{product-very-short} helper script - -You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. You can use the script in empty clusters, however, use with caution in production clusters because the script installs Operators with automatic upgrades and default settings, which can introduce unplanned changes, version conflicts, or policy misalignments. -You can install the OpenShift Serverless infrastructure for the Orchestrator plugin in empty clusters by using the {product-very-short} helper script. +You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. You can use the script in empty clusters. For more information on controlling the installation of the Operators, see link:https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/[Install your Operator with OLM]. -[WARNING] -==== -This method of installation is not suitable for production clusters. The {product-very-short} helper script installs Operators with automatic upgrades and default settings, which can introduce unplanned changes, version conflicts, or policy misalignments. -==== +WARNING: Use the {product-very-short} helper script for a quick-start on an empty cluster. Do not use it in production. .Procedure . Download the `plugin-infra.sh` script as shown in the following example: @@ -71,4 +66,9 @@ $ ./plugin-infra.sh ---- .{product-very-short} Orchestrator Infra Helm Chart -You can use {product-very-short} Orchestrator Infra Helm Chart to install components for the Orchestrator plugins in empty clusters. \ No newline at end of file +You can use {product-very-short} Orchestrator Infra Helm Chart to install components for the Orchestrator plugins in empty clusters. + +[IMPORTANT] +==== +The Orchestrator Infra Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade Operators: you must approve the install plans. +==== \ No newline at end of file From fc2bfed8b4d22afb7675bf41519ae974cefab0f7 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 20 Aug 2025 23:28:10 +0200 Subject: [PATCH 03/13] Apply suggestions --- ...erstanding-orchestrator-plugin-dependencies-operator.adoc | 5 ----- 1 file changed, 5 deletions(-) diff --git a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc index 182b0145cd..52b51282e9 100644 --- a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc +++ b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc @@ -7,11 +7,6 @@ The Orchestrator plugin in {product-very-short} requires components such as Sona * A `SonataflowPlatform` CR * `NetworkPolicies` that allow traffic between infrastructure resources (Knative, Serverless Logic Operator), monitoring traffic, and intra-namespace traffic -[NOTE] -==== -Orchestrator currently supports only {ocp-short}; it is not available on AKS, EKS, or GKE. -==== - The `orchestrator-backend` plugin uses the `sonataflow-platform-data-index-service`, which the `SonataFlowPlatform` CR creates to communicate with the SonataFlow platform. The Operator resolves the dependency reference SonataFlow against the `sonataflow.yaml` manifest included in its profile configuration (`config/profile/rhdh/plugin-deps/sonataflow.yaml`) and applies it to create the required resources. From e3b08ca08c6ea9e97dfa40ae69c8760220121580 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 20 Aug 2025 23:37:47 +0200 Subject: [PATCH 04/13] Apply suggestions --- ...understanding-orchestrator-plugin-dependencies-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc index 52b51282e9..7aeabbbc97 100644 --- a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc +++ b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc @@ -16,7 +16,7 @@ The Operator automatically applies the `sonataflow.yaml` manifest, creating the [IMPORTANT] ==== The `SonataFlowPlatform` CR contains Data Index service that requires PostgreSQL database as shown in the following example: -+ + [source,yaml,subs="+quotes,+attributes"] ---- persistence: From a623504905c71a47a838a9b9e376230f9873336e Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 08:58:45 +0200 Subject: [PATCH 05/13] Apply Peer and Tech suggestions --- .../proc-enable-orchestrator-plugin.adoc | 26 +++++-------------- ...ll-components-for-orchestrator-plugin.adoc | 2 +- 2 files changed, 7 insertions(+), 21 deletions(-) diff --git a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc index 8e0caec4e8..eaad340861 100644 --- a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc @@ -10,26 +10,12 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy .Procedure -. To enable the Orchestrator plugin with default settings, set `disabled: false` for the package. For example, `package: "@redhat/backstage-plugin-orchestrator@` is set to `disabled: false`: +. To enable the Orchestrator plugin with default settings, set `disabled: false` for the package. For example, `package: "@redhat/backstage-plugin-orchestrator@` is set to `disabled: false`: + [source,yaml] ---- -- package: "@redhat/backstage-plugin-orchestrator@" +- package: "@redhat/backstage-plugin-orchestrator@" disabled: false - integrity: sha512-fOSJv2PgtD2urKwBM7p9W6gV/0UIHSf4pkZ9V/wQO0eg0Zi5Mys/CL1ba3nO9x9l84MX11UBZ2r7PPVJPrmOtw== - pluginConfig: - dynamicPlugins: - frontend: - red-hat-developer-hub.backstage-plugin-orchestrator: - appIcons: - - importName: OrchestratorIcon - name: orchestratorIcon - dynamicRoutes: - - importName: OrchestratorPage - menuItem: - icon: orchestratorIcon - text: Orchestrator - path: /orchestrator ---- .Example: Complete configuration of the Orchestrator plugin @@ -44,15 +30,15 @@ data: includes: - dynamic-plugins.default.yaml plugins: - - package: "@redhat/backstage-plugin-orchestrator@" + - package: "@redhat/backstage-plugin-orchestrator@1.6.0" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@" + - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.6.0" disabled: false dependencies: - ref: sonataflow - - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@" + - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.6.0" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form-widgets@" + - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.6.0" disabled: false --- apiVersion: rhdh.redhat.com/v1alpha3 diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 702eabd171..706317ef2f 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -70,5 +70,5 @@ You can use {product-very-short} Orchestrator Infra Helm Chart to install compon [IMPORTANT] ==== -The Orchestrator Infra Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade Operators: you must approve the install plans. +The Orchestrator Infra Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade the Operator: you must approve the install plans. ==== \ No newline at end of file From 1a31fe2e9e0218dac671b3eb82ad92eed31a90d9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 09:18:43 +0200 Subject: [PATCH 06/13] Apply Peer and Tech suggestions --- .../proc-install-components-for-orchestrator-plugin.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 706317ef2f..c5202fefa8 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -15,7 +15,7 @@ To run the Orchestrator plugin successfully on {ocp-short}, you must install com + [NOTE] ==== -You must preinstall the components, or install them by using one of the supported methods described below (manual installation, helper script, or Helm chart). +You must preinstall the components, or install them by using one of the supported methods described in the following section (manual installation, helper script, or Helm chart). ==== .Procedure @@ -66,7 +66,7 @@ $ ./plugin-infra.sh ---- .{product-very-short} Orchestrator Infra Helm Chart -You can use {product-very-short} Orchestrator Infra Helm Chart to install components for the Orchestrator plugins in empty clusters. +You can use {product-very-short} Orchestrator Infra Helm chart to install components for the Orchestrator plugins in empty clusters. [IMPORTANT] ==== From 73d40f38d00b6525b65f0bd202935377c7e76f07 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 10:15:21 +0200 Subject: [PATCH 07/13] Apply Peer and Tech suggestions --- .../orchestrator/proc-enable-orchestrator-plugin.adoc | 2 +- ...roc-install-components-for-orchestrator-plugin.adoc | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc index eaad340861..c502fb55e6 100644 --- a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc @@ -15,7 +15,7 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy [source,yaml] ---- - package: "@redhat/backstage-plugin-orchestrator@" - disabled: false + disabled: false ---- .Example: Complete configuration of the Orchestrator plugin diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index c5202fefa8..a0d386eb02 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -15,7 +15,7 @@ To run the Orchestrator plugin successfully on {ocp-short}, you must install com + [NOTE] ==== -You must preinstall the components, or install them by using one of the supported methods described in the following section (manual installation, helper script, or Helm chart). +You must preinstall the components, or install them by using one of the supported methods. ==== .Procedure @@ -24,7 +24,7 @@ To install components (Operators) that provide the dependencies required by the * Manual installation * {product-very-short} helper script -* {product-very-short} Orchestrator Infra Helm Chart +* Orchestrator Infrastructure for {product} + These components enable the creation of the `SonataFlowPlatform` custom resource and several supporting `NetworkPolicy` resources. @@ -65,10 +65,10 @@ curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs $ ./plugin-infra.sh ---- -.{product-very-short} Orchestrator Infra Helm Chart -You can use {product-very-short} Orchestrator Infra Helm chart to install components for the Orchestrator plugins in empty clusters. +.Orchestrator Infrastructure for {product} +You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins in empty clusters. [IMPORTANT] ==== -The Orchestrator Infra Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade the Operator: you must approve the install plans. +Orchestrator Infrastructure for {product} is suitable for production use. By default, it does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. ==== \ No newline at end of file From aa18cb2a2c7f1085e5e680c314a606ee09d4f44a Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 10:42:32 +0200 Subject: [PATCH 08/13] Apply Peer and Tech suggestions --- .../proc-install-components-for-orchestrator-plugin.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index a0d386eb02..fd89ae6fc2 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -24,7 +24,7 @@ To install components (Operators) that provide the dependencies required by the * Manual installation * {product-very-short} helper script -* Orchestrator Infrastructure for {product} +* Orchestrator Infrastructure for {product} Helm chart + These components enable the creation of the `SonataFlowPlatform` custom resource and several supporting `NetworkPolicy` resources. @@ -65,10 +65,10 @@ curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs $ ./plugin-infra.sh ---- -.Orchestrator Infrastructure for {product} +.Orchestrator Infrastructure for {product} Helm chart You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins in empty clusters. [IMPORTANT] ==== -Orchestrator Infrastructure for {product} is suitable for production use. By default, it does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. +Orchestrator Infrastructure for {product} Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. ==== \ No newline at end of file From 54a48e3081c875da407735394caa089f51349b1b Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 11:13:04 +0200 Subject: [PATCH 09/13] Apply Armels suggestions --- .../proc-install-components-for-orchestrator-plugin.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index fd89ae6fc2..832ebcc9d3 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -70,5 +70,5 @@ You can use Orchestrator Infrastructure for {product} to install components for [IMPORTANT] ==== -Orchestrator Infrastructure for {product} Helm chart is suitable for production use. By default, it does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. +By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. ==== \ No newline at end of file From df0853596f12255deaaf8b6613c7c601b8911a28 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 11:24:56 +0200 Subject: [PATCH 10/13] Apply Armels suggestions --- .../proc-install-components-for-orchestrator-plugin.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 832ebcc9d3..c50aff33c0 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -45,11 +45,11 @@ For more information on preparing the required infrastructure, see link:https:// * Install the OpenShift Serverless Logic Operator .{product-very-short} helper script -You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. You can use the script in empty clusters. +You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. For more information on controlling the installation of the Operators, see link:https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/[Install your Operator with OLM]. -WARNING: Use the {product-very-short} helper script for a quick-start on an empty cluster. Do not use it in production. +WARNING: Use the {product-very-short} helper script for a quick-start. Do not use it in production. .Procedure . Download the `plugin-infra.sh` script as shown in the following example: @@ -66,7 +66,7 @@ $ ./plugin-infra.sh ---- .Orchestrator Infrastructure for {product} Helm chart -You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins in empty clusters. +You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins. [IMPORTANT] ==== From 4cca4b52b3e81510f3164e6852141c37d44404c4 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 12:01:33 +0200 Subject: [PATCH 11/13] Apply Armels suggestions --- .../con-supported-architecture-for-orchestrator.adoc | 8 ++++---- ...tanding-orchestrator-plugin-dependencies-operator.adoc | 4 ---- .../proc-install-components-for-orchestrator-plugin.adoc | 2 -- 3 files changed, 4 insertions(+), 10 deletions(-) diff --git a/modules/orchestrator/con-supported-architecture-for-orchestrator.adoc b/modules/orchestrator/con-supported-architecture-for-orchestrator.adoc index 76a685fe6b..86574176cf 100644 --- a/modules/orchestrator/con-supported-architecture-for-orchestrator.adoc +++ b/modules/orchestrator/con-supported-architecture-for-orchestrator.adoc @@ -6,7 +6,7 @@ You can use Orchestrator to design, run, and monitor workflows that automate key To help you get started quickly, the following Orchestrator plugin components are included by default in the `dynamic-plugins.default.yaml` file: -* `"@redhat/backstage-plugin-orchestrator"` -* `"@redhat/backstage-plugin-orchestrator-backend-dynamic"` -* `"@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic"` -* `"@redhat/backstage-plugin-orchestrator-form-widgets"` \ No newline at end of file +* `"backstage-plugin-orchestrator"` +* `"backstage-plugin-orchestrator-backend-dynamic"` +* `"backstage-plugin-scaffolder-backend-module-orchestrator-dynamic"` +* `"backstage-plugin-orchestrator-form-widgets"` \ No newline at end of file diff --git a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc index 7aeabbbc97..b3022a475b 100644 --- a/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc +++ b/modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc @@ -9,10 +9,6 @@ The Orchestrator plugin in {product-very-short} requires components such as Sona The `orchestrator-backend` plugin uses the `sonataflow-platform-data-index-service`, which the `SonataFlowPlatform` CR creates to communicate with the SonataFlow platform. -The Operator resolves the dependency reference SonataFlow against the `sonataflow.yaml` manifest included in its profile configuration (`config/profile/rhdh/plugin-deps/sonataflow.yaml`) and applies it to create the required resources. - -The Operator automatically applies the `sonataflow.yaml` manifest, creating the `SonataFlowPlatform` CR and required `NetworkPolicy` resources in the {product-custom-resource-type} CR namespace. - [IMPORTANT] ==== The `SonataFlowPlatform` CR contains Data Index service that requires PostgreSQL database as shown in the following example: diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index c50aff33c0..7c6fe7209b 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -25,8 +25,6 @@ To install components (Operators) that provide the dependencies required by the * Manual installation * {product-very-short} helper script * Orchestrator Infrastructure for {product} Helm chart -+ -These components enable the creation of the `SonataFlowPlatform` custom resource and several supporting `NetworkPolicy` resources. .Manual installation From 0012d6002c0802973df47c44d48504e0a2683f8d Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 12:48:02 +0200 Subject: [PATCH 12/13] Minor fixes --- .../proc-install-components-for-orchestrator-plugin.adoc | 2 +- .../proc-install-rhdh-with-orchestrator-helm-cli.adoc | 2 +- .../proc-install-rhdh-with-orchestrator-helm-webui.adoc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 7c6fe7209b..4f099631e8 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -68,5 +68,5 @@ You can use Orchestrator Infrastructure for {product} to install components for [IMPORTANT] ==== -By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans. +By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-install or auto-upgrade the required Serverless Operators: you must approve the install plans. ==== \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc index d8ebfdc5f0..459358b591 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -23,7 +23,7 @@ helm install `` openshift-helm-charts/redhat-developer-hub-orchest + [IMPORTANT] ==== -You must be a cluster administrator to install the `redhat-developer-hub-orchestrator-infra` Helm chart because it deploys additional cluster-scoped OpenShift Serverless and OpenShift Serverless Logic Operators. As an administrator, you need to manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. +You must be an administrator to install the `redhat-developer-hub-orchestrator-infra` Helm chart because it deploys additional cluster-scoped OpenShift Serverless and OpenShift Serverless Logic Operators. As an administrator, you need to manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. ==== . Install the Backstage chart with the orchestrator enabled as shown in the following example: diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc index d7f1f49a37..0798af20e3 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc @@ -6,7 +6,7 @@ You can install {product} ({product-very-short}) with the Orchestrator by using .Prerequisites -* You are logged in to the {ocp-short} web console as a cluster administrator. +* You are logged in to the {ocp-short} web console as an administrator. * You have access to the {product} Helm chart repository. * Your cluster has internet access or the Helm charts are mirrored in a disconnected environment. @@ -20,7 +20,7 @@ You can install {product} ({product-very-short}) with the Orchestrator by using + [IMPORTANT] ==== -You must be a cluster administrator to install the Orchestrator Infrastructure for {product} Helm chart because it deploys cluster-scoped resources. As an administrator, you need to manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. +You must be an administrator to install the Orchestrator Infrastructure for {product} Helm chart because it deploys cluster-scoped resources. As an administrator, you need to manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. ==== + As a regular user, search for the {product} chart and install it by setting the value of `orchestrator.enabled` to `true`. Otherwise, the Orchestrator will not be deployed. From 9b0b7f5a7430c4a38675c361e86c9e679ed804bd Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 21 Aug 2025 12:52:27 +0200 Subject: [PATCH 13/13] Minor fixes --- .../proc-install-components-for-orchestrator-plugin.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc index 4f099631e8..fd0d5c8ad9 100644 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc @@ -52,7 +52,7 @@ WARNING: Use the {product-very-short} helper script for a quick-start. Do not us .Procedure . Download the `plugin-infra.sh` script as shown in the following example: + -[code,terminal] +[source,terminal,subs="+attributes,+quotes"] ---- curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/release-${PRODUCT_VERSION}/config/profile/rhdh/plugin-infra/plugin-infra.sh # Specify the {product} version in the URL or use main ----