From c471ff6cbe1a18e222fa342804f07f4e3622ea19 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 25 Nov 2025 22:04:57 +0100 Subject: [PATCH 01/13] Restructure the Orchestrator --- ...ng-and-deploying-serverless-workflows.adoc | 5 +- ...sembly-install-rhdh-orchestrator-helm.adoc | 18 ++++++ ...ly-install-rhdh-orchestrator-operator.adoc | 16 +++++ .../assembly-install-rhdh-orchestrator.adoc | 28 --------- ...embly-orchestrator-plugins-components.adoc | 58 +++++++++++++++++++ ... => assembly-rhdh-about-orchestrator.adoc} | 27 ++------- .../con-architecture-overview.adoc | 2 +- .../con-benefits-of-workflow-images.adoc | 2 +- .../con-build-sh-script-and-its-uses.adoc | 2 +- ...riables-supported-by-the-build-script.adoc | 2 +- .../con-generated-workflow-manifests.adoc | 2 +- modules/orchestrator/con-getting-started.adoc | 10 ++++ ...estrator-plugin-dependencies-operator.adoc | 2 +- .../con-project-structure-overview.adoc | 2 +- modules/orchestrator/con-required-tools.adoc | 2 +- .../orchestrator/proc-building-locally.adoc | 2 +- .../proc-building-the-01-basic-workflow.adoc | 2 +- .../proc-creating-and-running-workflows.adoc | 2 +- ...proc-deploying-workflows-on-a-cluster.adoc | 2 +- ...bling-orchestrator-plugins-components.adoc | 4 +- .../proc-helper-script-overview.adoc | 2 +- ...best-practices-for-creating-workflows.adoc | 2 +- ...-compatibility-guide-for-orchestrator.adoc | 2 +- titles/orchestrator/master.adoc | 12 ++-- 24 files changed, 136 insertions(+), 72 deletions(-) create mode 100644 assemblies/assembly-install-rhdh-orchestrator-helm.adoc create mode 100644 assemblies/assembly-install-rhdh-orchestrator-operator.adoc delete mode 100644 assemblies/assembly-install-rhdh-orchestrator.adoc create mode 100644 assemblies/assembly-orchestrator-plugins-components.adoc rename assemblies/{assembly-orchestrator-rhdh.adoc => assembly-rhdh-about-orchestrator.adoc} (53%) create mode 100644 modules/orchestrator/con-getting-started.adoc diff --git a/assemblies/assembly-building-and-deploying-serverless-workflows.adoc b/assemblies/assembly-building-and-deploying-serverless-workflows.adoc index 619b4b8481..0f2ce266e1 100644 --- a/assemblies/assembly-building-and-deploying-serverless-workflows.adoc +++ b/assemblies/assembly-building-and-deploying-serverless-workflows.adoc @@ -42,4 +42,7 @@ include::modules/orchestrator/proc-building-the-01-basic-workflow.adoc[leveloffs include::modules/orchestrator/con-generated-workflow-manifests.adoc[leveloffset=+1] // deploy workflows on a cluster -include::modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc[leveloffset=+1] \ No newline at end of file +include::modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc[leveloffset=+1] + +// best practices when creating workflows +include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc new file mode 100644 index 0000000000..8d7b2f5a5d --- /dev/null +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="install-rhdh-orchestrator-helm.adoc"] +endif::[] +ifdef::context[] +[id="assembly-install-rhdh-orchestrator-helm"] +endif::[] +:context: install-rhdh-orchestrator += Installing {product} with Orchestrator using the {product} Helm chart + +You can install {product} with Orchestrator using the {product} Helm chart + +include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] + +include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1] + +include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-install-rhdh-orchestrator-operator.adoc b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc new file mode 100644 index 0000000000..93e016ee38 --- /dev/null +++ b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="install-rhdh-orchestrator-operator"] +endif::[] +ifdef::context[] +[id="assembly-install-rhdh-orchestrator-operator"] +endif::[] +:context: install-rhdh-orchestrator += Installing {product} with Orchestrator using the {product} Operator + +You can install {product} with Orchestrator using the {product} Operator + +include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] + +include::modules/orchestrator/proc-upgrading-the-orchestrator-plugin.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-install-rhdh-orchestrator.adoc b/assemblies/assembly-install-rhdh-orchestrator.adoc deleted file mode 100644 index 194a16fbeb..0000000000 --- a/assemblies/assembly-install-rhdh-orchestrator.adoc +++ /dev/null @@ -1,28 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="install-rhdh-orchestrator.adoc"] -endif::[] -ifdef::context[] -[id="assembly-install-rhdh-orchestrator"] -endif::[] -:context: install-rhdh-orchestrator -= Installing {product} with Orchestrator - -To install {product}, use one of the following methods: - -* The {product} Operator -* The {product} Helm chart - -// {product} Operator -include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] - -include::modules/orchestrator/proc-upgrading-the-orchestrator-plugin.adoc[leveloffset=+1] - -// {product} Helm chart -include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] - -include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1] - -include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] - diff --git a/assemblies/assembly-orchestrator-plugins-components.adoc b/assemblies/assembly-orchestrator-plugins-components.adoc new file mode 100644 index 0000000000..1d6d757de7 --- /dev/null +++ b/assemblies/assembly-orchestrator-plugins-components.adoc @@ -0,0 +1,58 @@ +:_mod-docs-content-type: ASSEMBLY + +[id="assembly-orchestrator-plugins-components_{context}"] += Orchestrator plugins components + +To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default: + +Orchestrator frontend plugins:: + +`backstage-plugin-orchestrator`::: +Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes. + +`backstage-plugin-orchestrator-form-widgets`::: +Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows. + +`backstage-plugin-orchestrator-form`::: +Provides the workflow execution form where you can define and submit the necessary input data required to start a new workflow instance. + +`backstage-plugin-orchestrator-form-api`::: +Defines the API for extending the workflow execution form. + +Orchestrator backend plugins:: + +`backstage-plugin-orchestrator-backend`::: +Gets workflow data into {product-short} making sure {product-very-short} ingests critical workflow metadata and runtime status fulfilling your need for visibility. + +`backstage-plugin-orchestrator-common`::: +Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries. + +`scaffolder-backend-module-orchestrator`::: +Provides callable actions from scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`. + +Notification plugins:: + +`backstage-plugin-notifications`::: +Provides notification frontend components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. + + +`backstage-plugin-signals`::: +Provides notification frontend components user experience enhancements so you can process the real-time lifecycle events. + +`backstage-plugin-notifications-backend-dynamic`::: +Provides notification backend components allowing you to manage and store the stream of workflow events, making sure that critical notifications are ready to be served to the front-end user interface. + +`backstage-plugin-signals-backend-dynamic`::: +Provides the backend components for notification user experience enhancements allowing you to establish the necessary communication channels for the event-driven orchestration that is core to Serverless Workflows. + +// enabling orchestrator plugins components +include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc[leveloffset=+1] + +// Orchestrator Infrastructure for {product} Helm chart +include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2] + +// manual installation +include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2] + +// {product-very-short} helper script +include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2] \ No newline at end of file diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-rhdh-about-orchestrator.adoc similarity index 53% rename from assemblies/assembly-orchestrator-rhdh.adoc rename to assemblies/assembly-rhdh-about-orchestrator.adoc index a155a47be6..1de86caf95 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-rhdh-about-orchestrator.adoc @@ -20,31 +20,14 @@ You can streamline and automate your work by using the Orchestrator in {product} 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) or Helm values file for Orchestrator +// compatibility guide for {product} Orchestrator +include::modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc[leveloffset=+1] // orchestrator architecture include::modules/orchestrator/con-architecture-overview.adoc[leveloffset=+1] -// compatibility guide for {product} Orchestrator -include::modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc[leveloffset=+1] +// getting started +include::modules/orchestrator/con-getting-started.adoc[leveloffset=+1] // provisioning plugin dependencies -include::modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1] - -// enabling orchestrator plugins components -include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc[leveloffset=+1] - -// Orchestrator Infrastructure for {product} Helm chart -include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2] - -// manual installation -include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2] - -// {product-very-short} helper script -include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2] - -// best practices when creating workflows -include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1] +include::modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/orchestrator/con-architecture-overview.adoc b/modules/orchestrator/con-architecture-overview.adoc index 9e939e7c0d..ff8a054cf1 100644 --- a/modules/orchestrator/con-architecture-overview.adoc +++ b/modules/orchestrator/con-architecture-overview.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-architecture-overview.adoc_{context}"] +[id="con-architecture-overview_{context}"] = Understand Orchestrator architecture The Orchestrator architecture is composed of several components, each contributing to the running and management of workflows. diff --git a/modules/orchestrator/con-benefits-of-workflow-images.adoc b/modules/orchestrator/con-benefits-of-workflow-images.adoc index 743c7e31ed..eba8db364e 100644 --- a/modules/orchestrator/con-benefits-of-workflow-images.adoc +++ b/modules/orchestrator/con-benefits-of-workflow-images.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-benefits-of-workflow-images.adoc_{context}"] +[id="con-benefits-of-workflow-images_{context}"] = Benefits of workflow images While the OpenShift Serverless Logic Operator supports the building of workflows dynamically, this approach is primarily for experimentation. diff --git a/modules/orchestrator/con-build-sh-script-and-its-uses.adoc b/modules/orchestrator/con-build-sh-script-and-its-uses.adoc index 45ce77b4e3..233efe6fa8 100644 --- a/modules/orchestrator/con-build-sh-script-and-its-uses.adoc +++ b/modules/orchestrator/con-build-sh-script-and-its-uses.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-build-sh-script-and-its-uses.adoc_{context}"] +[id="con-build-sh-script-and-its-uses_{context}"] = The `build-sh` script functionality and important flags The `build-sh` script does the following tasks in order: diff --git a/modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc b/modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc index d114fc18ab..c7924b3670 100644 --- a/modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc +++ b/modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-environment-variables-supported-by-the-build-script.adoc_{context}"] +[id="con-environment-variables-supported-by-the-build-script_{context}"] = Environment variables supported by the build script The `build-sh` script supports the following environment variables to customize the workflow build process without modifying the script itself: diff --git a/modules/orchestrator/con-generated-workflow-manifests.adoc b/modules/orchestrator/con-generated-workflow-manifests.adoc index 5315700804..909e0280fe 100644 --- a/modules/orchestrator/con-generated-workflow-manifests.adoc +++ b/modules/orchestrator/con-generated-workflow-manifests.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-generated-workflow-manifests.adoc_{context}"] +[id="con-generated-workflow-manifests_{context}"] = Generated workflow manifests The following example is an illustration of what is generated under the `01_basic/manifests`: diff --git a/modules/orchestrator/con-getting-started.adoc b/modules/orchestrator/con-getting-started.adoc new file mode 100644 index 0000000000..3627993767 --- /dev/null +++ b/modules/orchestrator/con-getting-started.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-getting-started_{context}"] += Getting started with Orchestrator + +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) or Helm values file for Orchestrator \ No newline at end of file diff --git a/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc b/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc index 73b60d060e..f3c85f6b7c 100644 --- a/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc +++ b/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-orchestrator-plugin-dependencies-operator.adoc_{context}"] +[id="con-orchestrator-plugin-dependencies-operator_{context}"] = Orchestrator plugin dependencies for Operator installation When you enable the Orchestrator plugin in your {product-custom-resource-type} custom resource (CR), the Operator automatically provisions the following required dependencies: diff --git a/modules/orchestrator/con-project-structure-overview.adoc b/modules/orchestrator/con-project-structure-overview.adoc index fb83bbf427..5c60e0cd9f 100644 --- a/modules/orchestrator/con-project-structure-overview.adoc +++ b/modules/orchestrator/con-project-structure-overview.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-project-structure-overview.adoc_{context}"] +[id="con-project-structure-overview_{context}"] = Project structure overview The project utilizes *Quarkus project layout* (Maven project structure). This structure is illustrated by the following `01_basic` workflow example: diff --git a/modules/orchestrator/con-required-tools.adoc b/modules/orchestrator/con-required-tools.adoc index 4c1081b31b..6da088e18e 100644 --- a/modules/orchestrator/con-required-tools.adoc +++ b/modules/orchestrator/con-required-tools.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="con-required-tools.adoc_{context}"] +[id="con-required-tools_{context}"] = Required tools To run the `build-sh` script locally and manage the workflow lifecycle, you must install the following command-line tools: diff --git a/modules/orchestrator/proc-building-locally.adoc b/modules/orchestrator/proc-building-locally.adoc index 4ac66621d1..f6dc1a4409 100644 --- a/modules/orchestrator/proc-building-locally.adoc +++ b/modules/orchestrator/proc-building-locally.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-building-locally.adoc_{context}"] +[id="proc-building-locally_{context}"] = Building workflow images locally You can use the build script (`build.sh`) to build workflow images. You can run it either locally or inside a container. This section highlights how build workflow images locally. diff --git a/modules/orchestrator/proc-building-the-01-basic-workflow.adoc b/modules/orchestrator/proc-building-the-01-basic-workflow.adoc index 6dad50f109..08e9f05f5e 100644 --- a/modules/orchestrator/proc-building-the-01-basic-workflow.adoc +++ b/modules/orchestrator/proc-building-the-01-basic-workflow.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-building-the-01-basic-workflow.adoc_{context}"] +[id="proc-building-the-01-basic-workflow_{context}"] = Building the `01_basic` workflow To run the script from the root directory of the repository, you must use the `-w` flag to point to the workflow directory. Additionally, specify the output directory with the `-m` flag. diff --git a/modules/orchestrator/proc-creating-and-running-workflows.adoc b/modules/orchestrator/proc-creating-and-running-workflows.adoc index f470822d8c..ae11544098 100644 --- a/modules/orchestrator/proc-creating-and-running-workflows.adoc +++ b/modules/orchestrator/proc-creating-and-running-workflows.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-creating-and-running-workflows.adoc_{context}"] +[id="proc-creating-and-running-workflows_{context}"] = Creating and running your serverless workflow project locally The `kn-workflow` CLI is an essential tool that generates workflow manifests and project structures. To ensure successful development and immediate testing, begin developing a new serverless workflow locally by completing the following steps: diff --git a/modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc b/modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc index 29cbcf7b11..01265a09c1 100644 --- a/modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc +++ b/modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-deploying-workflows-on-a-cluster.adoc_{context}"] +[id="proc-deploying-workflows-on-a-cluster_{context}"] = Deploying workflows on a cluster You can deploy the workflow on a cluster, since the image is pushed to the image registry and the deployment manifests are available. diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index 961515c066..af52489a30 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-enabling-orchestrator-plugins-components.adoc_{context}"] +[id="proc-enabling-orchestrator-plugins-components_{context}"] = Enabling Orchestrator plugins components To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default: @@ -83,4 +83,4 @@ plugins: disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" disabled: false ----- +---- \ No newline at end of file diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc index a3c8a8fb31..0fb8ab3e4e 100644 --- a/modules/orchestrator/proc-helper-script-overview.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-helper-script-overview.adoc_{context}"] +[id="proc-helper-script-overview_{context}"] = Installing components using the `{product-very-short}` helper script You can use the {product-very-short} helper script `plugin-infra.sh` to quickly install the OpenShift Serverless infrastructure and Openshift Serverless Logic infrastructure required by the Orchestrator plugin. diff --git a/modules/orchestrator/ref-best-practices-for-creating-workflows.adoc b/modules/orchestrator/ref-best-practices-for-creating-workflows.adoc index 5b9b127a94..97fa4e1851 100644 --- a/modules/orchestrator/ref-best-practices-for-creating-workflows.adoc +++ b/modules/orchestrator/ref-best-practices-for-creating-workflows.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: CONCEPT -[id="ref-best-practices-for-creating-workflows.adoc_{context}"] +[id="ref-best-practices-for-creating-workflows_{context}"] = Best practices when creating serverless workflows Create effective serverless workflows using thoughtful approaches to design, handle data, and manage error by following these best practices based on the Serverless Workflow Domain Specific Language (DSL) principles. These principles help you to build robust workflows. diff --git a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc index cb008b876c..dcda0752c9 100644 --- a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc +++ b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="con-compatibility-guide-for-orchestrator.adoc_{context}"] +[id="con-compatibility-guide-for-orchestrator_{context}"] = Compatibility guide for Orchestrator The following table lists the {product-very-short} Orchestrator plugin versions and their compatible corresponding infrastructure versions. diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc index dba76a5d30..e939d12026 100644 --- a/titles/orchestrator/master.adoc +++ b/titles/orchestrator/master.adoc @@ -6,12 +6,16 @@ include::artifacts/attributes.adoc[] :abstract: As an administrator, you can use Orchestrator to enable serverless workflows in {product} to support cloud migration, developer onboarding, and custom workflows. = {title} -include::assemblies/assembly-orchestrator-rhdh.adoc[leveloffset=+1] +include::assemblies/assembly-rhdh-about-orchestrator.adoc[leveloffset=+1] -include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] +include::assemblies/assembly-orchestrator-plugins-components.adoc[leveloffset=+1] -include::assemblies/assembly-install-rhdh-orchestrator.adoc[leveloffset=+1] +include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] + +include::assemblies/assembly-install-rhdh-orchestrator-operator.adoc[leveloffset=+1] include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1] -include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc[leveloffset=+1] + +include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] \ No newline at end of file From efdb519da9f1e102194a23fc06e2aafdca1e03c1 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 25 Nov 2025 22:21:35 +0100 Subject: [PATCH 02/13] Restructure the Orchestrator --- assemblies/assembly-install-rhdh-orchestrator-helm.adoc | 2 +- assemblies/assembly-install-rhdh-orchestrator-operator.adoc | 2 +- assemblies/assembly-orchestrator-plugins-components.adoc | 6 +++--- .../proc-enabling-orchestrator-plugins-components.adoc | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index 8d7b2f5a5d..b03d3970fb 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -9,7 +9,7 @@ endif::[] :context: install-rhdh-orchestrator = Installing {product} with Orchestrator using the {product} Helm chart -You can install {product} with Orchestrator using the {product} Helm chart +You can install {product} with Orchestrator by using the {product} Helm chart include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] diff --git a/assemblies/assembly-install-rhdh-orchestrator-operator.adoc b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc index 93e016ee38..6802cf2799 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-operator.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc @@ -9,7 +9,7 @@ endif::[] :context: install-rhdh-orchestrator = Installing {product} with Orchestrator using the {product} Operator -You can install {product} with Orchestrator using the {product} Operator +You can install {product} with Orchestrator by using the {product} Operator include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] diff --git a/assemblies/assembly-orchestrator-plugins-components.adoc b/assemblies/assembly-orchestrator-plugins-components.adoc index 1d6d757de7..b2345d39d6 100644 --- a/assemblies/assembly-orchestrator-plugins-components.adoc +++ b/assemblies/assembly-orchestrator-plugins-components.adoc @@ -5,7 +5,7 @@ To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default: -Orchestrator frontend plugins:: +Orchestrator front end plugins:: `backstage-plugin-orchestrator`::: Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes. @@ -33,11 +33,11 @@ Provides callable actions from scaffolder templates, such as `orchestrator:workf Notification plugins:: `backstage-plugin-notifications`::: -Provides notification frontend components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. +Provides notification front end components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. `backstage-plugin-signals`::: -Provides notification frontend components user experience enhancements so you can process the real-time lifecycle events. +Provides notification front end components user experience enhancements so you can process the real-time lifecycle events. `backstage-plugin-notifications-backend-dynamic`::: Provides notification backend components allowing you to manage and store the stream of workflow events, making sure that critical notifications are ready to be served to the front-end user interface. diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index af52489a30..772480855c 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -33,7 +33,7 @@ Provides callable actions from scaffolder templates, such as `orchestrator:workf Notification plugins:: `backstage-plugin-notifications`::: -Provides notification frontend components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. +Provides notification front end components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. `backstage-plugin-signals`::: From bbded54ea4c61f0a2d421aa2e08bc84e2cc74d17 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 25 Nov 2025 22:33:22 +0100 Subject: [PATCH 03/13] Restructure the Orchestrator --- .../proc-enabling-orchestrator-plugins-components.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index 772480855c..f7f8fcfde8 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -22,7 +22,7 @@ Defines the API for extending the workflow execution form. Orchestrator backend plugins:: `backstage-plugin-orchestrator-backend`::: -Gets workflow data into {product-short} making sure {product-very-short} ingests critical workflow metadata and runtime status fulfilling your need for visibility. +Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility. `backstage-plugin-orchestrator-common`::: Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries. From f1803da910f9cb5514859df572eccdc4a0416e3e Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 25 Nov 2025 22:45:24 +0100 Subject: [PATCH 04/13] Restructure the Orchestrator --- ...embly-orchestrator-plugins-components.adoc | 2 +- ...bling-orchestrator-plugins-components.adoc | 42 ------------------- 2 files changed, 1 insertion(+), 43 deletions(-) diff --git a/assemblies/assembly-orchestrator-plugins-components.adoc b/assemblies/assembly-orchestrator-plugins-components.adoc index b2345d39d6..e58b865602 100644 --- a/assemblies/assembly-orchestrator-plugins-components.adoc +++ b/assemblies/assembly-orchestrator-plugins-components.adoc @@ -22,7 +22,7 @@ Defines the API for extending the workflow execution form. Orchestrator backend plugins:: `backstage-plugin-orchestrator-backend`::: -Gets workflow data into {product-short} making sure {product-very-short} ingests critical workflow metadata and runtime status fulfilling your need for visibility. +Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility. `backstage-plugin-orchestrator-common`::: Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries. diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index f7f8fcfde8..9605849286 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -3,48 +3,6 @@ [id="proc-enabling-orchestrator-plugins-components_{context}"] = Enabling Orchestrator plugins components -To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default: - -Orchestrator frontend plugins:: - -`backstage-plugin-orchestrator`::: -Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes. - -`backstage-plugin-orchestrator-form-widgets`::: -Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows. - -`backstage-plugin-orchestrator-form`::: -Provides the workflow execution form where you can define and submit the necessary input data required to start a new workflow instance. - -`backstage-plugin-orchestrator-form-api`::: -Defines the API for extending the workflow execution form. - -Orchestrator backend plugins:: - -`backstage-plugin-orchestrator-backend`::: -Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility. - -`backstage-plugin-orchestrator-common`::: -Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries. - -`scaffolder-backend-module-orchestrator`::: -Provides callable actions from scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`. - -Notification plugins:: - -`backstage-plugin-notifications`::: -Provides notification front end components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. - - -`backstage-plugin-signals`::: -Provides notification frontend components user experience enhancements so you can process the real-time lifecycle events. - -`backstage-plugin-notifications-backend-dynamic`::: -Provides notification backend components allowing you to manage and store the stream of workflow events, making sure that critical notifications are ready to be served to the front-end user interface. - -`backstage-plugin-signals-backend-dynamic`::: -Provides the backend components for notification user experience enhancements allowing you to establish the necessary communication channels for the event-driven orchestration that is core to Serverless Workflows. - .Prerequisites * You have installed the following operators: From e0f91bf768f315a476a81ae76ae28f5033511141 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 26 Nov 2025 14:33:31 +0100 Subject: [PATCH 05/13] Restucture Orchestrator documentation --- assemblies/assembly-install-rhdh-orchestrator-helm.adoc | 4 ++-- assemblies/assembly-install-rhdh-orchestrator-operator.adoc | 4 ++-- titles/orchestrator/master.adoc | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index b03d3970fb..925ccba39d 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -7,9 +7,9 @@ ifdef::context[] [id="assembly-install-rhdh-orchestrator-helm"] endif::[] :context: install-rhdh-orchestrator -= Installing {product} with Orchestrator using the {product} Helm chart += Installing {product} with Orchestrator by using the {product} Helm chart -You can install {product} with Orchestrator by using the {product} Helm chart +You can install {product} with Orchestrator by using the {product} Helm chart. include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] diff --git a/assemblies/assembly-install-rhdh-orchestrator-operator.adoc b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc index 6802cf2799..e7f98c1fca 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-operator.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-operator.adoc @@ -7,9 +7,9 @@ ifdef::context[] [id="assembly-install-rhdh-orchestrator-operator"] endif::[] :context: install-rhdh-orchestrator -= Installing {product} with Orchestrator using the {product} Operator += Installing {product} with Orchestrator by using the {product} Operator -You can install {product} with Orchestrator by using the {product} Operator +You can install {product} with Orchestrator by using the {product} Operator. include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc index e939d12026..ded9f37e70 100644 --- a/titles/orchestrator/master.adoc +++ b/titles/orchestrator/master.adoc @@ -10,12 +10,12 @@ include::assemblies/assembly-rhdh-about-orchestrator.adoc[leveloffset=+1] include::assemblies/assembly-orchestrator-plugins-components.adoc[leveloffset=+1] -include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] - include::assemblies/assembly-install-rhdh-orchestrator-operator.adoc[leveloffset=+1] -include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1] +include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc[leveloffset=+1] +include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1] + include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] \ No newline at end of file From b0d989e7e2faeebdaf373d9d4c6f2fd50b36a984 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 27 Nov 2025 13:33:45 +0100 Subject: [PATCH 06/13] Restructure the Orchestrator --- ...sembly-install-rhdh-orchestrator-helm.adoc | 5 +- ...embly-orchestrator-plugins-components.adoc | 54 +------------------ ...estrator-plugins-technical-appendixes.adoc | 10 ++++ modules/orchestrator/con-getting-started.adoc | 9 +++- ...bling-orchestrator-plugins-components.adoc | 28 +++++++--- ...stall-rhdh-with-orchestrator-helm-cli.adoc | 19 +++++++ ...-compatibility-guide-for-orchestrator.adoc | 3 +- titles/orchestrator/master.adoc | 4 +- 8 files changed, 70 insertions(+), 62 deletions(-) create mode 100644 assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index 925ccba39d..ec87f501f4 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -15,4 +15,7 @@ include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[ include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1] -include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] \ No newline at end of file +include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] + +// manual installation +include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-orchestrator-plugins-components.adoc b/assemblies/assembly-orchestrator-plugins-components.adoc index e58b865602..7634635079 100644 --- a/assemblies/assembly-orchestrator-plugins-components.adoc +++ b/assemblies/assembly-orchestrator-plugins-components.adoc @@ -1,58 +1,8 @@ :_mod-docs-content-type: ASSEMBLY [id="assembly-orchestrator-plugins-components_{context}"] -= Orchestrator plugins components -To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default: - -Orchestrator front end plugins:: - -`backstage-plugin-orchestrator`::: -Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes. - -`backstage-plugin-orchestrator-form-widgets`::: -Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows. - -`backstage-plugin-orchestrator-form`::: -Provides the workflow execution form where you can define and submit the necessary input data required to start a new workflow instance. - -`backstage-plugin-orchestrator-form-api`::: -Defines the API for extending the workflow execution form. - -Orchestrator backend plugins:: - -`backstage-plugin-orchestrator-backend`::: -Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility. - -`backstage-plugin-orchestrator-common`::: -Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries. - -`scaffolder-backend-module-orchestrator`::: -Provides callable actions from scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`. - -Notification plugins:: - -`backstage-plugin-notifications`::: -Provides notification front end components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking. - - -`backstage-plugin-signals`::: -Provides notification front end components user experience enhancements so you can process the real-time lifecycle events. - -`backstage-plugin-notifications-backend-dynamic`::: -Provides notification backend components allowing you to manage and store the stream of workflow events, making sure that critical notifications are ready to be served to the front-end user interface. - -`backstage-plugin-signals-backend-dynamic`::: -Provides the backend components for notification user experience enhancements allowing you to establish the necessary communication channels for the event-driven orchestration that is core to Serverless Workflows. += Enabling Orchestrator plugins components // enabling orchestrator plugins components -include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc[leveloffset=+1] - -// Orchestrator Infrastructure for {product} Helm chart -include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2] - -// manual installation -include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2] - -// {product-very-short} helper script -include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2] \ No newline at end of file +include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc b/assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc new file mode 100644 index 0000000000..31675b3c75 --- /dev/null +++ b/assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: ASSEMBLY + +[id="assembly-orchestrator-plugins-technical-appendixes_{context}"] + += Technical appendix + +The following appendix provides technical information, and details on non-production tools, such as the {product-very-short} helper script, which might be helpful for understanding setup options or quick testing. + +// {product-very-short} helper script +include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/orchestrator/con-getting-started.adoc b/modules/orchestrator/con-getting-started.adoc index 3627993767..bb8c66e14c 100644 --- a/modules/orchestrator/con-getting-started.adoc +++ b/modules/orchestrator/con-getting-started.adoc @@ -7,4 +7,11 @@ 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) or Helm values file for Orchestrator \ No newline at end of file +* Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator + +[NOTE] +==== +When using the {product-very-short} Operator, the required infrastructure components are provisioned automatically once the Orchestrator plugins are enabled in the {product-custom-resource-type} CR. + +When using the {product-very-short} Helm chart, the required infrastructure components are installed automatically using the dedicated `orchestrator-infra` Helm chart prior to enabling the Orchestrator plugins in the main {product-very-short} chart. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index 9605849286..92e0350316 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -3,6 +3,28 @@ [id="proc-enabling-orchestrator-plugins-components_{context}"] = Enabling Orchestrator plugins components +To use the Orchestrator, enable the following Orchestrator plugins for {product}, that are disabled by default: + +Orchestrator-frontend plugin:: + +`backstage-plugin-orchestrator`::: +Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes. + +Orchestrator-backend plugin:: + +`backstage-plugin-orchestrator-backend`::: +Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility. + +Orchestrator-form-widget:: + +`backstage-plugin-orchestrator-form-widgets`::: +Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows. + +Orchestrator-scaffolder-backend-module:: + +`scaffolder-backend-module-orchestrator`::: +Provides callable actions from Scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`. + .Prerequisites * You have installed the following operators: @@ -27,12 +49,6 @@ plugins: disabled: false - package: "@redhat/backstage-plugin-orchestrator-form-widgets@{product-chart-version}" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-common@{product-chart-version}" - disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form@{product-chart-version}" - disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form-api@{product-chart-version}" - disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals" 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 7cc4395fdb..d29f94b80f 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -14,6 +14,25 @@ This is a one-off requirement and must be completed before enabling the Orchestr .Procedure +. Run the `helm install` command for the `orchestrator-infra` chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. ++ +[source,terminal,subs="attributes+"] +---- +helm install redhat-developer/redhat-developer-hub-orchestrator-infra +---- ++ +[NOTE] +==== +You must complete this one-off requirement before enabling the Orchestrator plugin. +==== + +. Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation. + +[IMPORTANT] +==== +By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-approve the required Serverless Operators. You must manually approve the install plans. +==== + . As an administrator, install relevant cluster-wide resources. + [source,yaml,subs="+quotes,+attributes"] diff --git a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc index dcda0752c9..f969cb13d3 100644 --- a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc +++ b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc @@ -10,7 +10,8 @@ The following table lists the {product-very-short} Orchestrator plugin versions | Orchestrator plugin version | {product} ({product-very-short}) version | OpenShift version | OpenShift Serverless Logic (OSL) version | OpenShift Serverless version | Orchestrator `1.5` | `1.5` | `4.14` - `4.18` | OSL `1.35` | `1.35` | Orchestrator `1.6` | `1.6` | `4.14` - `4.18` | OSL `1.36` | `1.36` -| Orchestrator `1.7` ({product-very-short} {product-version}) | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36` +| Orchestrator `1.7.1` | `1.7` | `4.16` - `4.19` | OSL `1.36` | `1.36` +| Orchestrator `1.8.2` | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36` |=== [NOTE] diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc index ded9f37e70..db8fec69fe 100644 --- a/titles/orchestrator/master.adoc +++ b/titles/orchestrator/master.adoc @@ -18,4 +18,6 @@ include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-e include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1] -include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] + +include::assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc[leveloffset=+1] \ No newline at end of file From 7c7c4318e12be6d5da8f7f44b5db29185d52eb94 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 27 Nov 2025 14:29:17 +0100 Subject: [PATCH 07/13] Restructure the Orchestrator --- modules/orchestrator/con-architecture-overview.adoc | 8 ++------ modules/orchestrator/con-getting-started.adoc | 2 +- .../proc-helm-install-components-orchestrator-plugin.adoc | 2 +- .../proc-install-rhdh-with-orchestrator-helm-cli.adoc | 2 +- 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/modules/orchestrator/con-architecture-overview.adoc b/modules/orchestrator/con-architecture-overview.adoc index ff8a054cf1..edd9b0f7c0 100644 --- a/modules/orchestrator/con-architecture-overview.adoc +++ b/modules/orchestrator/con-architecture-overview.adoc @@ -13,16 +13,12 @@ Orchestrator backend plugins::: Get workflow data into {product-short}. Notifications plugins::: Inform users about workflow events. -Sonataflow:: - -The Sonataflow orchestrator and its subcomponents handle the workflows. -The {product} Orchestrator and the {product} Helm chart manage the following subcomponents lifecycle: - -OpenShift Serverless Logic Operator::: Manages the Sonataflow custom resource (CR), where each CR represents a deployed workflow. +Openshift Serverless Logic Operator:: Serves as the workflow engine, and its subcomponents handle running, executing and providing persistence for the workflows. The {product} Operator and the {product} Helm chart manage the following lifecycle of these subcomponents: Sonataflow Runtime/Workflow Application::: Functions as a deployed workflow. Operates as an HTTP server, handling requests for running workflow instances. It is managed as a Kubernetes (K8s) deployment by the Openshift Serverless Logic Operator. Data Index Service::: Serves as a repository for workflow definitions, instances, and associated jobs. It exposes a GraphQL API used by the Orchestrator backend plugin to retrieve workflow definitions and instances. + Job Service::: Orchestrates scheduled tasks for workflows. OpenShift Serverless::: Provides serverless capabilities essential for workflow communication. It employs Knative eventing to interface with the Data Index service and uses Knative functions to introduce more complex logic to workflows. diff --git a/modules/orchestrator/con-getting-started.adoc b/modules/orchestrator/con-getting-started.adoc index bb8c66e14c..498fdfea6f 100644 --- a/modules/orchestrator/con-getting-started.adoc +++ b/modules/orchestrator/con-getting-started.adoc @@ -13,5 +13,5 @@ To start using Orchestrator in {product-very-short}, you must: ==== When using the {product-very-short} Operator, the required infrastructure components are provisioned automatically once the Orchestrator plugins are enabled in the {product-custom-resource-type} CR. -When using the {product-very-short} Helm chart, the required infrastructure components are installed automatically using the dedicated `orchestrator-infra` Helm chart prior to enabling the Orchestrator plugins in the main {product-very-short} chart. +When using the {product-very-short} Helm chart, the required infrastructure components are installed automatically using the dedicated `redhat-developer-hub-orchestrator-infra` Helm chart prior to enabling the Orchestrator plugins in the main {product-very-short} chart. ==== \ No newline at end of file diff --git a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc index 0f1710d211..a6cb091f8d 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -7,7 +7,7 @@ You can use Orchestrator Infrastructure for {product} to install components for .Procedure -. Run the `helm install` command for the `orchestrator-infra` chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. +. Run the `helm install` command for the `redhat-developer-hub-orchestrator-infra` Helm chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. + [source,terminal,subs="attributes+"] ---- 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 d29f94b80f..6fa579d86f 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -14,7 +14,7 @@ This is a one-off requirement and must be completed before enabling the Orchestr .Procedure -. Run the `helm install` command for the `orchestrator-infra` chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. +. Run the `helm install` command for the `redhat-developer-hub-orchestrator-infra` Helm chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. + [source,terminal,subs="attributes+"] ---- From e17aa56687b9785296a123e14f87047f29d2563a Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 27 Nov 2025 17:01:36 +0100 Subject: [PATCH 08/13] Apply suggestions --- ...bling-orchestrator-plugins-components.adoc | 8 +++--- ...r-airgapped-env-using-helm-chart-full.adoc | 6 ++--- ...talling-the-orchestrator-common-steps.adoc | 26 +++++++++---------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index 92e0350316..1684a4b635 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -41,13 +41,13 @@ Provides callable actions from Scaffolder templates, such as `orchestrator:workf [source,yaml,subs="+attributes,+quotes"] ---- plugins: - - package: "@redhat/backstage-plugin-orchestrator@{product-chart-version}" + - package: "@redhat/backstage-plugin-orchestrator@{orchestrator-plugin-version}" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@{product-chart-version}" + - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@{orchestrator-plugin-version}" disabled: false - - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{product-chart-version}" + - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{orchestrator-plugin-version}" disabled: false - - package: "@redhat/backstage-plugin-orchestrator-form-widgets@{product-chart-version}" + - package: "@redhat/backstage-plugin-orchestrator-form-widgets@{orchestrator-plugin-version}" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications" disabled: false diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc index bbf0dcc5a4..352857fe47 100644 --- a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc @@ -37,7 +37,7 @@ mirror: - name: redhat-developer-hub version: "{product-bundle-version}" - name: redhat-developer-hub-orchestrator-infra - version: "{product-bundle-version}" + version: "{orchestrator-plugin-version}" operators: - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 @@ -118,7 +118,7 @@ To configure the Orchestrator plugins to use a custom registry, complete the fol + * Open your `values.yaml` file. + -* Explicitly list the Orchestrator plugin packages under the `orchestrator.plugins` section. +* List the Orchestrator plugin packages under the `orchestrator.plugins` section. You must replace the simplified package references with the full URLs that point to your custom NPM registry, as shown in the following example: + [source,yaml] @@ -148,7 +148,7 @@ Enter the address of your custom registry and make sure the integrity checksum, * Restart the {product-very-short} Pod and wait for the components to deploy properly. -* After deployment is complete, go to the **{product-very-short}** UI and confirm that the Orchestrator UI is accessible and functioning correctly. +* After deployment is complete, go to the *{product-very-short}* UI and confirm that the *Orchestrator* UI is accessible and functioning correctly. [NOTE] ==== diff --git a/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc b/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc index 3d218665b1..34abbd1305 100644 --- a/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc +++ b/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc @@ -1,26 +1,26 @@ -. Download the Node Package Manager (NPM) packages for orchestrator {product-bundle-version} using any of the following methods: +. Download the Node Package Manager (NPM) packages for orchestrator {orchestrator-plugin-version} using any of the following methods: * Download them as `tgz` files from the following registry: -** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz -** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz -** https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz -** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{orchestrator-plugin-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{orchestrator-plugin-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{orchestrator-plugin-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{orchestrator-plugin-version}.tgz + * Alternatively, use the NPM packages from link:https://npm.registry.redhat.com[{company-name} NPM registry] as shown in the following example: + [source,subs="+attributes,+quotes"] ---- -npm pack "@redhat/backstage-plugin-orchestrator@{product-bundle-version}" --registry=https://npm.registry.redhat.com -npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@{product-bundle-version}" --registry=https://npm.registry.redhat.com -npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{product-bundle-version} --registry=https://npm.registry.redhat.com -npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@{product-bundle-version}" --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-orchestrator@{orchestrator-plugin-version}" --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@{orchestrator-plugin-version}" --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{orchestrator-plugin-version} --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@{orchestrator-plugin-version}" --registry=https://npm.registry.redhat.com ---- . Push the NPM packages you have downloaded to your NPM server, as shown in the following example: + [source,subs="+attributes,+quotes"] ---- -npm publish backstage-plugin-orchestrator-{product-bundle-version}.tgz -npm publish backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz -npm publish backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz -npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz +npm publish backstage-plugin-orchestrator-{orchestrator-plugin-version}.tgz +npm publish backstage-plugin-orchestrator-backend-dynamic-{orchestrator-plugin-version}.tgz +npm publish backstage-plugin-orchestrator-form-widgets-{orchestrator-plugin-version}.tgz +npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{orchestrator-plugin-version}.tgz ---- \ No newline at end of file From 886bfe0ca177d2321f264c8381ce6f7be6ae998c Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 27 Nov 2025 17:36:47 +0100 Subject: [PATCH 09/13] Apply suggestions --- .../orchestrator/ref-compatibility-guide-for-orchestrator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc index f969cb13d3..9cc46a9ce4 100644 --- a/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc +++ b/modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc @@ -11,7 +11,7 @@ The following table lists the {product-very-short} Orchestrator plugin versions | Orchestrator `1.5` | `1.5` | `4.14` - `4.18` | OSL `1.35` | `1.35` | Orchestrator `1.6` | `1.6` | `4.14` - `4.18` | OSL `1.36` | `1.36` | Orchestrator `1.7.1` | `1.7` | `4.16` - `4.19` | OSL `1.36` | `1.36` -| Orchestrator `1.8.2` | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36` +| Orchestrator {orchestrator-plugin-version} | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36` |=== [NOTE] From 1eb738987a1dc404af4e61f6a80bbc2c178f0865 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Sun, 30 Nov 2025 21:21:30 +0100 Subject: [PATCH 10/13] Apply new suggestions --- artifacts/attributes.adoc | 1 + modules/orchestrator/con-getting-started.adoc | 2 +- ...hestrator-plugin-dependencies-operator.adoc | 2 +- .../proc-enable-orchestrator-plugin.adoc | 18 ++++++++++++------ ...nstall-rhdh-with-orchestrator-helm-cli.adoc | 2 +- 5 files changed, 16 insertions(+), 9 deletions(-) diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index 7eb0d06030..a064a3b45d 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -29,6 +29,7 @@ :ocp-version: 4.19 :osd-version: 4 :rhoserverless-version: 1.36 +:orchestrator-plugin-version: 1.8.2 // Product recurrent configuration items (in alphabetical order) :my-app-config-config-map: my-rhdh-app-config diff --git a/modules/orchestrator/con-getting-started.adoc b/modules/orchestrator/con-getting-started.adoc index 498fdfea6f..069685266f 100644 --- a/modules/orchestrator/con-getting-started.adoc +++ b/modules/orchestrator/con-getting-started.adoc @@ -5,7 +5,7 @@ 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 +* Install the required infrastructure components, such as OpenShift Serverless Operator, and OpenShift Serverless Logic Operator * Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator diff --git a/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc b/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc index f3c85f6b7c..13758d78fb 100644 --- a/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc +++ b/modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc @@ -44,4 +44,4 @@ The Operator automatically creates the required Role and _RoleBinding_ resource ==== .Additional resources -* link:https://github.com/redhat-developer/rhdh-operator/blob/release-1.7/docs/dynamic-plugins.md#dynamic-plugins-dependency-management[Dynamic plugins dependency management] +* link:https://github.com/redhat-developer/rhdh-operator/blob/release-{product-version}/docs/dynamic-plugins.md#dynamic-plugins-dependency-management[Dynamic plugins dependency management] diff --git a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc index cde4ff32dc..130be3d8f6 100644 --- a/modules/orchestrator/proc-enable-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-enable-orchestrator-plugin.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-enable-orchestrator-plugin_{context}"] -= Enabling the Orchestrator plugin using Operator += Enabling the Orchestrator plugin using the Operator You can enable the Orchestrator plugin in {product-very-short} by configuring dynamic plugins in your {product-custom-resource-type} custom resource (CR). @@ -19,8 +19,14 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy disabled: false ---- + +[NOTE] +==== +When you enable the plugins, the pre-loaded plugin configuration are used. +Additionally, the `ref: sonataflow` field installs the Openshift Serverless and Openshift Serverless Logic resources. This happens automatically when you are using the Operator. +==== ++ .Example: Complete configuration of the Orchestrator plugin -[source,yaml] +[source,subs="+attributes,+quotes"] ---- apiVersion: v1 kind: ConfigMap @@ -31,7 +37,7 @@ data: includes: - dynamic-plugins.default.yaml plugins: - - package: "@redhat/backstage-plugin-orchestrator@1.7.1" + - package: "@redhat/backstage-plugin-orchestrator@{orchestrator-plugin-version}" disabled: false pluginConfig: dynamicPlugins: @@ -59,7 +65,7 @@ data: if: anyOf: - IsOrchestratorCatalogTabAvailable - - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.7.1" + - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@{orchestrator-plugin-version}" disabled: false pluginConfig: orchestrator: @@ -67,13 +73,13 @@ data: url: http://sonataflow-platform-data-index-service dependencies: - ref: sonataflow - - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.7.1" + - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{orchestrator-plugin-version}" disabled: false pluginConfig: orchestrator: dataIndexService: url: http://sonataflow-platform-data-index-service - - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.7.1" + - package: "@redhat/backstage-plugin-orchestrator-form-widgets@{orchestrator-plugin-version}" disabled: false pluginConfig: dynamicPlugins: 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 6fa579d86f..288364c443 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -8,7 +8,7 @@ You can install {product} ({product-very-short}) on {ocp-short} with the Orchest .Prerequisites * You are logged in as an administrator and have access to the {product} Helm chart repository. -* You can install the necessary infrastructures resources, such as SonataFlow, alongside {product-very-short} in the same namespace. +* You can install the necessary infrastructures resources, such as other Openshift operators (OpenShift Serverless and OpenShift Serverless Logic), alongside {product-very-short} in the same namespace. + This is a one-off requirement and must be completed before enabling the Orchestrator plugin. From 05144a8af2cd42399ffc4ca343327965114d4b8b Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 1 Dec 2025 15:32:32 +0100 Subject: [PATCH 11/13] Apply new suggestions --- modules/orchestrator/con-getting-started.adoc | 2 +- .../orchestrator/proc-helper-script-overview.adoc | 2 +- ...proc-install-rhdh-with-orchestrator-helm-cli.adoc | 12 ------------ 3 files changed, 2 insertions(+), 14 deletions(-) diff --git a/modules/orchestrator/con-getting-started.adoc b/modules/orchestrator/con-getting-started.adoc index 069685266f..43ee0888b9 100644 --- a/modules/orchestrator/con-getting-started.adoc +++ b/modules/orchestrator/con-getting-started.adoc @@ -11,7 +11,7 @@ To start using Orchestrator in {product-very-short}, you must: [NOTE] ==== -When using the {product-very-short} Operator, the required infrastructure components are provisioned automatically once the Orchestrator plugins are enabled in the {product-custom-resource-type} CR. +When using the {product-very-short} Operator, you must first install the required infrastructure components. The Operator then provisions the dependent SonataFlow resources once the Orchestrator plugins are enabled in the {product-custom-resource-type} CR. When using the {product-very-short} Helm chart, the required infrastructure components are installed automatically using the dedicated `redhat-developer-hub-orchestrator-infra` Helm chart prior to enabling the Orchestrator plugins in the main {product-very-short} chart. ==== \ No newline at end of file diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc index 0fb8ab3e4e..e1e8c9328a 100644 --- a/modules/orchestrator/proc-helper-script-overview.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -16,7 +16,7 @@ Do not use `plugin-infra.sh` in production. + [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 +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 ---- . Run the script: 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 288364c443..d5b19055c5 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -14,18 +14,6 @@ This is a one-off requirement and must be completed before enabling the Orchestr .Procedure -. Run the `helm install` command for the `redhat-developer-hub-orchestrator-infra` Helm chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components. -+ -[source,terminal,subs="attributes+"] ----- -helm install redhat-developer/redhat-developer-hub-orchestrator-infra ----- -+ -[NOTE] -==== -You must complete this one-off requirement before enabling the Orchestrator plugin. -==== - . Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation. [IMPORTANT] From 0c6acc90ae8bfc86f69a4fdcdbec22ec5a06b75e Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 1 Dec 2025 17:27:02 +0100 Subject: [PATCH 12/13] Apply new suggestions --- modules/orchestrator/proc-helper-script-overview.adoc | 2 +- ...l-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc index e1e8c9328a..824535b122 100644 --- a/modules/orchestrator/proc-helper-script-overview.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -16,7 +16,7 @@ Do not use `plugin-infra.sh` in production. + [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 +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 ---- . Run the script: diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc index 352857fe47..4bb41ec815 100644 --- a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc @@ -37,7 +37,7 @@ mirror: - name: redhat-developer-hub version: "{product-bundle-version}" - name: redhat-developer-hub-orchestrator-infra - version: "{orchestrator-plugin-version}" + version: "{product-bundle-version}" operators: - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 From 8a7a3338ec8160f71c5e30b120c8e53878de9c61 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 1 Dec 2025 17:34:46 +0100 Subject: [PATCH 13/13] Apply new suggestions --- assemblies/assembly-install-rhdh-orchestrator-helm.adoc | 2 +- assemblies/assembly-rhdh-about-orchestrator.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index ec87f501f4..1c25fb1bc1 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY ifndef::context[] -[id="install-rhdh-orchestrator-helm.adoc"] +[id="install-rhdh-orchestrator-helm"] endif::[] ifdef::context[] [id="assembly-install-rhdh-orchestrator-helm"] diff --git a/assemblies/assembly-rhdh-about-orchestrator.adoc b/assemblies/assembly-rhdh-about-orchestrator.adoc index 1de86caf95..8e6fd2b8a4 100644 --- a/assemblies/assembly-rhdh-about-orchestrator.adoc +++ b/assemblies/assembly-rhdh-about-orchestrator.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY ifndef::context[] -[id="assembly-orchestrator-rhdh.adoc"] +[id="assembly-orchestrator-rhdh"] endif::[] ifdef::context[] [id="assembly-orchestrator-rhdh"]