From 4344b6757c60cf2060e7b41853b8db07ce33acf3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 7 Jul 2025 22:43:52 +0300 Subject: [PATCH 1/8] Installation process (Helm-based) for orchestrator --- ...sembly-install-rhdh-orchestrator-helm.adoc | 15 ++++ .../proc-install-rhdh-orchestrator-helm.adoc | 80 +++++++++++++++++++ titles/orchestrator/artifacts | 1 + titles/orchestrator/assemblies | 1 + titles/orchestrator/docinfo.xml | 13 +++ titles/orchestrator/images | 1 + titles/orchestrator/master.adoc | 11 +++ titles/orchestrator/modules | 1 + 8 files changed, 123 insertions(+) create mode 100644 assemblies/assembly-install-rhdh-orchestrator-helm.adoc create mode 100644 modules/installation/proc-install-rhdh-orchestrator-helm.adoc create mode 120000 titles/orchestrator/artifacts create mode 120000 titles/orchestrator/assemblies create mode 100644 titles/orchestrator/docinfo.xml create mode 120000 titles/orchestrator/images create mode 100644 titles/orchestrator/master.adoc create mode 120000 titles/orchestrator/modules diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc new file mode 100644 index 0000000000..b91665d939 --- /dev/null +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -0,0 +1,15 @@ +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="install-rhdh-orchestrator-helm"] +endif::[] +ifdef::context[] +[id="install-rhdh-orchestrator-helm_{context}"] +endif::[] += Installing {product} with Orchestrator using Helm + +:context: install-rhdh-orchestrator-helm + +You can install {product} with Orchestrator using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. + +include::modules/installation/proc-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] diff --git a/modules/installation/proc-install-rhdh-orchestrator-helm.adoc b/modules/installation/proc-install-rhdh-orchestrator-helm.adoc new file mode 100644 index 0000000000..2a9b567bb0 --- /dev/null +++ b/modules/installation/proc-install-rhdh-orchestrator-helm.adoc @@ -0,0 +1,80 @@ +// Module included in the following assemblies +// assembly-orchestrator-helm-modules.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-install-orchestrator-helm_{context}"] += Install Orchestrator Helm + +You can install the Orchestrator flavor of {product} ({product-very-short}) on OpenShift using Helm charts, enabling serverless workflows and workflow orchestration capabilities. + +.Prerequisites + +* You are logged in as an administrator on the OpenShift cluster. +* You have installed Helm and configured locally. +* You have access to the {product} Helm chart repository. + +.Procedure + +. Add required Helm repositories: ++ +[source,yaml] +---- +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo add backstage https://backstage.github.io/charts +helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart +---- + +. Install the orchestrator infrastructure Helm chart: ++ +[source,yaml] +---- +helm install redhat-developer/redhat-developer-hub-orchestrator-infra +---- + +. Manually approve the Install Plans for OpenShift Serverless and Serverless Logic Operators and wait for deployment. + +. Install the Backstage chart with the orchestrator enabled: ++ +[source,bash] +---- +helm install redhat-developer/backstage --set orchestrator.enabled=true +---- + +. To disable serverlessLogicOperator and serverlessOperator if managed externally: ++ +[source,bash] + +. (Optional) Enable Notifications and Signals plugins by adding the following to your values.yaml before installation or upgrade: ++ +[source,yaml] +---- +disabled: false +package: "./dynamic-plugins/dist/backstage-plugin-notifications" + +disabled: false +package: "./dynamic-plugins/dist/backstage-plugin-signals" + +disabled: false +package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" + +disabled: false +package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" +---- + +. (Optional) If using an external database, add the following configuration in your values.yaml: ++ +[source,yaml] +---- +externalDBsecretRef: +externalDBName: "" +externalDBHost: "" +externalDBPort: "" +---- + +.Verification + +. Verify that the orchestrator plugin is visible in the {product} UI. + +. Test creating and executing workflows to confirm orchestration is functioning correctly. + +. Check orchestrator pod logs to confirm successful workflow execution and plugin readiness. diff --git a/titles/orchestrator/artifacts b/titles/orchestrator/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/orchestrator/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/orchestrator/assemblies b/titles/orchestrator/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/orchestrator/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/orchestrator/docinfo.xml b/titles/orchestrator/docinfo.xml new file mode 100644 index 0000000000..e7fae0f66e --- /dev/null +++ b/titles/orchestrator/docinfo.xml @@ -0,0 +1,13 @@ +{title} +{product} +{product-version} +{subtitle} + + + {abstract} + + + {company-name} Customer Content Services + + diff --git a/titles/orchestrator/images b/titles/orchestrator/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/orchestrator/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc new file mode 100644 index 0000000000..e767771a24 --- /dev/null +++ b/titles/orchestrator/master.adoc @@ -0,0 +1,11 @@ +include::artifacts/attributes.adoc[] +:context: orchestrator-helm +:imagesdir: images +:title: Orchestrator flavor installation using Helm +:subtitle: Install, configure, and manage the Orchestrator flavor in {product} using Helm +:abstract: As a {product} ({product-very-short}) administrator, you can install and configure the Orchestrator flavor using Helm, ensuring your environment is prepared for workflow orchestration with {product}. + += {title} + +//Helm-based +include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/orchestrator/modules b/titles/orchestrator/modules new file mode 120000 index 0000000000..8b0e854007 --- /dev/null +++ b/titles/orchestrator/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file From 49c4735f25ee4d99d7ce6cdcfb7500263b3c0d65 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 7 Jul 2025 22:49:55 +0300 Subject: [PATCH 2/8] Installation process (Helm-based) for orchestrator --- assemblies/assembly-install-rhdh-orchestrator-helm.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index b91665d939..ffe94da751 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -10,6 +10,6 @@ endif::[] :context: install-rhdh-orchestrator-helm -You can install {product} with Orchestrator using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. +You can install {product} with Orchestrator by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. include::modules/installation/proc-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] From bfa62553b7e5643b5e56d242665cdfc1aaa3ec72 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 28 Jul 2025 15:54:26 +0200 Subject: [PATCH 3/8] Installation process (Helm-based) for orchestrator --- ...sembly-install-rhdh-orchestrator-helm.adoc | 8 +- .../proc-install-orchestrator-helm-cli.adoc | 118 ++++++++++++++++++ .../proc-install-orchestrator-helm-webui.adoc | 40 ++++++ .../proc-install-rhdh-orchestrator-helm.adoc | 80 ------------ 4 files changed, 163 insertions(+), 83 deletions(-) create mode 100644 modules/installation/proc-install-orchestrator-helm-cli.adoc create mode 100644 modules/installation/proc-install-orchestrator-helm-webui.adoc delete mode 100644 modules/installation/proc-install-rhdh-orchestrator-helm.adoc diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index ffe94da751..ee79fe5bf5 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -6,10 +6,12 @@ endif::[] ifdef::context[] [id="install-rhdh-orchestrator-helm_{context}"] endif::[] -= Installing {product} with Orchestrator using Helm += Installing {product} with the Orchestrator on OpenShift using Helm :context: install-rhdh-orchestrator-helm -You can install {product} with Orchestrator by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. +You can install {product} with Orchestrator on {ocp-short} by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. -include::modules/installation/proc-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] +include::modules/installation/proc-install-orchestrator-helm-cli.adoc[leveloffset=+1] + +include::modules/installation/proc-install-orchestrator-helm-webui.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/installation/proc-install-orchestrator-helm-cli.adoc b/modules/installation/proc-install-orchestrator-helm-cli.adoc new file mode 100644 index 0000000000..3f2c8c3957 --- /dev/null +++ b/modules/installation/proc-install-orchestrator-helm-cli.adoc @@ -0,0 +1,118 @@ +// Module included in the following assemblies +// assembly-orchestrator-helm-modules.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-install-orchestrator-helm-cli_{context}"] += Install the Orchestrator flavor using the Helm CLI + +You can install the Orchestrator flavor of {product} ({product-very-short}) on OpenShift using the Helm CLI. This method provides flexibility for custom configurations and automation. The Orchestrator flavor enables serverless workflows and orchestration capabilities. + + +[IMPORTANT] +==== +You must be a cluster administrator to install the Orchestrator Helm chart because it deploys cluster-scoped resources. The {product} Helm chart may be installed by a user with namespace-level access. +==== + +.Prerequisites + +* You are logged in to the OpenShift cluster using the `oc` CLI. +* You have installed Helm and configured locally. +* You have access to the official Red Hat container registry (`registry.redhat.io`). +* You have created a `values.yaml` file for the deployment. +* You have access to the {product} Helm chart repository. + +.Procedure + +. Add the official OpenShift Helm charts repository: ++ +[source,bash] +---- +helm repo add openshift-helm-charts https://charts.openshift.io/ +helm repo update +---- + +. Install the orchestrator infrastructure Helm chart: ++ +[source,bash] +---- +helm install openshift-helm-charts/redhat-developer-hub-orchestrator-infra +---- + +. Manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. Wait until they are successfully deployed. + +. Install the Backstage chart with the orchestrator enabled: ++ +[source,bash] +---- +helm install openshift-helm-charts/redhat-developer-hub --version 1.7.0 \ + --set orchestrator.enabled=true +---- + +. (Optional) Disable the installation of the Serverless Logic and Serverless Operators if they are managed externally: ++ +[source,bash] +---- +helm install redhat-developer/backstage \ + --set orchestrator.serverlessOperator=false \ + --set orchestrator.serverlessLogicOperator=false +---- + +. (Optional) Enable *Notifications* and *Signals* plugins by adding them under `global.dynamic.plugins` in your `values.yaml` file: ++ +[source,yaml] +---- +global: + dynamic: + plugins: + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-notifications" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-signals" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" +---- + +. (Optional) If using an external database, add the following configuration under `orchestrator.sonataflowPlatform` in your `values.yaml` file: ++ +[source,yaml] +---- +orchestrator: + sonataflowPlatform: + externalDBsecretRef: "" + externalDBName: "" + externalDBHost: "" + externalDBPort: "" +---- + +[NOTE] +==== +This only configures the Orchestrator's use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in: +link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html/configuring_red_hat_developer_hub/configuring-external-postgresql-databases#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. +==== + +.Verification + +. Verify that the orchestrator plugin is visible in the {product} UI. + +. Create and run sample workflows to confirm orchestration is functioning correctly. + +. Check the logs of the Orchestrator pod to verify workflow execution and plugin readiness. +Use the following commands to check the Orchestrator pod logs: ++ +[source,bash] +---- +# List pods in the namespace +oc get pods -n + +# Replace with the actual pod name +oc logs -n +---- + +. (Optional) Stream logs in real-time: ++ +[source,bash] +---- +oc logs -n -f +---- \ No newline at end of file diff --git a/modules/installation/proc-install-orchestrator-helm-webui.adoc b/modules/installation/proc-install-orchestrator-helm-webui.adoc new file mode 100644 index 0000000000..f86c2d6384 --- /dev/null +++ b/modules/installation/proc-install-orchestrator-helm-webui.adoc @@ -0,0 +1,40 @@ +[id="proc-install-orchestrator-helm-webui_{context}"] += Install the Orchestrator flavor using the OpenShift web console + +You can install the Orchestrator flavor of {product} ({product-very-short}) using the OpenShift Container Platform (OCP) web console. This method is useful if you prefer a graphical interface or want to deploy cluster-wide resources without using the Helm CLI. + +[IMPORTANT] +==== +You must be a cluster administrator to install the Orchestrator Helm chart because it deploys cluster-scoped resources. +==== + +.Prerequisites + +* You are logged in to the OpenShift Container Platform web console as a cluster 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. + +.Procedure + +. In the OpenShift web console, go to menu:Helm[Helm Charts]. + +. Click btn:[Repository] and confirm that the {product} Helm chart repository is available. If not, add it manually. + +. Search for the Orchestrator Helm chart and click btn:[Install]. + +. In the install form: + * Choose or create a target namespace. + * Accept or modify the default values as needed. + * Review and confirm the cluster-scoped resources that the chart will install. + +. Click btn:[Install] to deploy the chart. + +. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases]. + +.Verification + +After deployment completes: + +* The orchestrator-related pods should be running in the selected namespace. +* Cluster-wide resources such as CustomResourceDefinitions (CRDs) should be present. +* You can begin connecting the orchestrator to your {product} UI. diff --git a/modules/installation/proc-install-rhdh-orchestrator-helm.adoc b/modules/installation/proc-install-rhdh-orchestrator-helm.adoc deleted file mode 100644 index 2a9b567bb0..0000000000 --- a/modules/installation/proc-install-rhdh-orchestrator-helm.adoc +++ /dev/null @@ -1,80 +0,0 @@ -// Module included in the following assemblies -// assembly-orchestrator-helm-modules.adoc - -:_mod-docs-content-type: PROCEDURE -[id="proc-install-orchestrator-helm_{context}"] -= Install Orchestrator Helm - -You can install the Orchestrator flavor of {product} ({product-very-short}) on OpenShift using Helm charts, enabling serverless workflows and workflow orchestration capabilities. - -.Prerequisites - -* You are logged in as an administrator on the OpenShift cluster. -* You have installed Helm and configured locally. -* You have access to the {product} Helm chart repository. - -.Procedure - -. Add required Helm repositories: -+ -[source,yaml] ----- -helm repo add bitnami https://charts.bitnami.com/bitnami -helm repo add backstage https://backstage.github.io/charts -helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart ----- - -. Install the orchestrator infrastructure Helm chart: -+ -[source,yaml] ----- -helm install redhat-developer/redhat-developer-hub-orchestrator-infra ----- - -. Manually approve the Install Plans for OpenShift Serverless and Serverless Logic Operators and wait for deployment. - -. Install the Backstage chart with the orchestrator enabled: -+ -[source,bash] ----- -helm install redhat-developer/backstage --set orchestrator.enabled=true ----- - -. To disable serverlessLogicOperator and serverlessOperator if managed externally: -+ -[source,bash] - -. (Optional) Enable Notifications and Signals plugins by adding the following to your values.yaml before installation or upgrade: -+ -[source,yaml] ----- -disabled: false -package: "./dynamic-plugins/dist/backstage-plugin-notifications" - -disabled: false -package: "./dynamic-plugins/dist/backstage-plugin-signals" - -disabled: false -package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" - -disabled: false -package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" ----- - -. (Optional) If using an external database, add the following configuration in your values.yaml: -+ -[source,yaml] ----- -externalDBsecretRef: -externalDBName: "" -externalDBHost: "" -externalDBPort: "" ----- - -.Verification - -. Verify that the orchestrator plugin is visible in the {product} UI. - -. Test creating and executing workflows to confirm orchestration is functioning correctly. - -. Check orchestrator pod logs to confirm successful workflow execution and plugin readiness. From ac922f175a8f604681bda8f4ec68c119852fb8fb Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 19 Aug 2025 08:59:12 +0200 Subject: [PATCH 4/8] Installation process (Helm-based) for orchestrator --- ...sembly-install-rhdh-orchestrator-helm.adoc | 8 +- .../proc-install-orchestrator-helm-cli.adoc | 118 ------------------ .../proc-install-orchestrator-helm-webui.adoc | 40 ------ ...stall-rhdh-with-orchestrator-helm-cli.adoc | 92 ++++++++++++++ ...all-rhdh-with-orchestrator-helm-webui.adoc | 37 ++++++ titles/orchestrator/master.adoc | 15 ++- 6 files changed, 143 insertions(+), 167 deletions(-) delete mode 100644 modules/installation/proc-install-orchestrator-helm-cli.adoc delete mode 100644 modules/installation/proc-install-orchestrator-helm-webui.adoc create mode 100644 modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc create mode 100644 modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc diff --git a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc index ee79fe5bf5..fad87cef5d 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -6,12 +6,12 @@ endif::[] ifdef::context[] [id="install-rhdh-orchestrator-helm_{context}"] endif::[] -= Installing {product} with the Orchestrator on OpenShift using Helm += Installing {product} with the Orchestrator plugin using Helm :context: install-rhdh-orchestrator-helm -You can install {product} with Orchestrator on {ocp-short} by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. +You can install {product} with Orchestrator by using the {product} Helm chart. Orchestrator brings serverless workflows into Backstage, targets application migration to the cloud, onboarding of developers, and user-made workflows of Backstage actions or external systems. -include::modules/installation/proc-install-orchestrator-helm-cli.adoc[leveloffset=+1] +include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] -include::modules/installation/proc-install-orchestrator-helm-webui.adoc[leveloffset=+1] \ No newline at end of file +include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1] diff --git a/modules/installation/proc-install-orchestrator-helm-cli.adoc b/modules/installation/proc-install-orchestrator-helm-cli.adoc deleted file mode 100644 index 3f2c8c3957..0000000000 --- a/modules/installation/proc-install-orchestrator-helm-cli.adoc +++ /dev/null @@ -1,118 +0,0 @@ -// Module included in the following assemblies -// assembly-orchestrator-helm-modules.adoc - -:_mod-docs-content-type: PROCEDURE -[id="proc-install-orchestrator-helm-cli_{context}"] -= Install the Orchestrator flavor using the Helm CLI - -You can install the Orchestrator flavor of {product} ({product-very-short}) on OpenShift using the Helm CLI. This method provides flexibility for custom configurations and automation. The Orchestrator flavor enables serverless workflows and orchestration capabilities. - - -[IMPORTANT] -==== -You must be a cluster administrator to install the Orchestrator Helm chart because it deploys cluster-scoped resources. The {product} Helm chart may be installed by a user with namespace-level access. -==== - -.Prerequisites - -* You are logged in to the OpenShift cluster using the `oc` CLI. -* You have installed Helm and configured locally. -* You have access to the official Red Hat container registry (`registry.redhat.io`). -* You have created a `values.yaml` file for the deployment. -* You have access to the {product} Helm chart repository. - -.Procedure - -. Add the official OpenShift Helm charts repository: -+ -[source,bash] ----- -helm repo add openshift-helm-charts https://charts.openshift.io/ -helm repo update ----- - -. Install the orchestrator infrastructure Helm chart: -+ -[source,bash] ----- -helm install openshift-helm-charts/redhat-developer-hub-orchestrator-infra ----- - -. Manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. Wait until they are successfully deployed. - -. Install the Backstage chart with the orchestrator enabled: -+ -[source,bash] ----- -helm install openshift-helm-charts/redhat-developer-hub --version 1.7.0 \ - --set orchestrator.enabled=true ----- - -. (Optional) Disable the installation of the Serverless Logic and Serverless Operators if they are managed externally: -+ -[source,bash] ----- -helm install redhat-developer/backstage \ - --set orchestrator.serverlessOperator=false \ - --set orchestrator.serverlessLogicOperator=false ----- - -. (Optional) Enable *Notifications* and *Signals* plugins by adding them under `global.dynamic.plugins` in your `values.yaml` file: -+ -[source,yaml] ----- -global: - dynamic: - plugins: - - disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications" - - disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals" - - disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" - - disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" ----- - -. (Optional) If using an external database, add the following configuration under `orchestrator.sonataflowPlatform` in your `values.yaml` file: -+ -[source,yaml] ----- -orchestrator: - sonataflowPlatform: - externalDBsecretRef: "" - externalDBName: "" - externalDBHost: "" - externalDBPort: "" ----- - -[NOTE] -==== -This only configures the Orchestrator's use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in: -link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html/configuring_red_hat_developer_hub/configuring-external-postgresql-databases#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. -==== - -.Verification - -. Verify that the orchestrator plugin is visible in the {product} UI. - -. Create and run sample workflows to confirm orchestration is functioning correctly. - -. Check the logs of the Orchestrator pod to verify workflow execution and plugin readiness. -Use the following commands to check the Orchestrator pod logs: -+ -[source,bash] ----- -# List pods in the namespace -oc get pods -n - -# Replace with the actual pod name -oc logs -n ----- - -. (Optional) Stream logs in real-time: -+ -[source,bash] ----- -oc logs -n -f ----- \ No newline at end of file diff --git a/modules/installation/proc-install-orchestrator-helm-webui.adoc b/modules/installation/proc-install-orchestrator-helm-webui.adoc deleted file mode 100644 index f86c2d6384..0000000000 --- a/modules/installation/proc-install-orchestrator-helm-webui.adoc +++ /dev/null @@ -1,40 +0,0 @@ -[id="proc-install-orchestrator-helm-webui_{context}"] -= Install the Orchestrator flavor using the OpenShift web console - -You can install the Orchestrator flavor of {product} ({product-very-short}) using the OpenShift Container Platform (OCP) web console. This method is useful if you prefer a graphical interface or want to deploy cluster-wide resources without using the Helm CLI. - -[IMPORTANT] -==== -You must be a cluster administrator to install the Orchestrator Helm chart because it deploys cluster-scoped resources. -==== - -.Prerequisites - -* You are logged in to the OpenShift Container Platform web console as a cluster 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. - -.Procedure - -. In the OpenShift web console, go to menu:Helm[Helm Charts]. - -. Click btn:[Repository] and confirm that the {product} Helm chart repository is available. If not, add it manually. - -. Search for the Orchestrator Helm chart and click btn:[Install]. - -. In the install form: - * Choose or create a target namespace. - * Accept or modify the default values as needed. - * Review and confirm the cluster-scoped resources that the chart will install. - -. Click btn:[Install] to deploy the chart. - -. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases]. - -.Verification - -After deployment completes: - -* The orchestrator-related pods should be running in the selected namespace. -* Cluster-wide resources such as CustomResourceDefinitions (CRDs) should be present. -* You can begin connecting the orchestrator to your {product} UI. diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc new file mode 100644 index 0000000000..0a86b63038 --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -0,0 +1,92 @@ +// Module included in the following assemblies +// assembly-orchestrator-helm-modules.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-install-rhdh-with-orchestrator-helm-cli_{context}"] += Installing {product} ({product-very-short}) on {ocp-short} with the Orchestrator using the Helm chart + +You can install {product} ({product-very-short}) on {ocp-short} with the Orchestrator by using the Helm chart. The installation automatically enables the required dynamic plugins and integrates workflow infrastructure. + +.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. ++ +This is a one-off requirement and must be completed before enabling the Orchestrator plugin. + +.Procedure + +. As an administrator, install cluster-wide resources. ++ +[source,yaml] +---- +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo add backstage https://backstage.github.io/charts +helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart + +helm install redhat-developer/redhat-developer-hub-orchestrator-infra +---- ++ +[IMPORTANT] +==== +You must be a cluster administrator to install the `redhat-developer-hub-orchestrator-infra` Helm chart because it deploys cluster-scoped resources. The administrator manually approves the installed plans by setting the values of the Openshift Serverless and Openshift Serverless Logic Operators to `true.` +==== + +. Install the Backstage chart with the orchestrator enabled as shown in the following example: ++ +[source,yaml] +---- +helm install openshift-helm-charts/redhat-developer-hub --version 1.7.0 \ + --set orchestrator.enabled=true +---- + +. (Optional) Enable *Notifications* and *Signals* plugins by adding them to the `global.dynamic.plugins` list in your `values.yaml` file as shown in the following example: ++ +[source,yaml] +---- +global: + dynamic: + plugins: + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-notifications" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-signals" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" + - disabled: false + package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" +---- + +. (Optional) You can disable the Serverless Logic and Serverless Operators individually or together by setting their values to `false`, as shown in the following example: ++ +[source,yaml] +---- +helm install openshift-helm-charts/redhat-developer-hub \ + --version 1.7.0 \ + --set orchestrator.enabled=true \ + --set orchestrator.serverlessOperator=false \ + --set orchestrator.serverlessLogicOperator=false +---- + +. (Optional) If you are using an external database, add the following configuration under `orchestrator.sonataflowPlatform` in your `values.yaml` file: ++ +[source,yaml] +---- +orchestrator: + sonataflowPlatform: + externalDBsecretRef: "" + externalDBName: "" # The name of the user-configured existing database (Not the database that the orchestrator and sonataflow resources use). + externalDBHost: "" + externalDBPort: "" +---- ++ +[NOTE] +==== +This only configures the Orchestrators use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in link:{configuring-book-url}#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. +==== + +.Verification + +. Verify that the orchestrator plugin is visible in the {product} UI. + +. Create and run sample workflows to confirm orchestration is functioning correctly. \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc new file mode 100644 index 0000000000..ad87694811 --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc @@ -0,0 +1,37 @@ +[id="proc-install-rhdh-with-orchestrator-helm-webui.adoc_{context}"] += Install {product} ({product-very-short}) using {ocp-short} web console + +You can install {product} ({product-very-short}) with the Orchestrator by using the ({ocp-short}) web console. This method is useful if you prefer a graphical interface or want to deploy cluster-wide resources without using the Helm CLI. + +.Prerequisites + +* You are logged in to the OpenShift Container Platform web console as a cluster 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. + +.Procedure + +. In the OpenShift web console, go to menu:Helm[Helm Charts]. + +. Click btn:[Repository] and confirm that the {product} Helm chart repository is available. + +. Search for the Orchestrator infrastructure for {product} and click btn:[Install]. ++ +[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. +==== ++ +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. + +. Wait until they are successfully deployed. + +. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases]. + +.Verification + +After deployment completes: + +* The orchestrator-related pods are running in the selected namespace. +* Cluster-wide resources are present. +* You can start connecting the orchestrator to your {product} UI. diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc index e767771a24..6af3d245fc 100644 --- a/titles/orchestrator/master.adoc +++ b/titles/orchestrator/master.adoc @@ -1,11 +1,16 @@ include::artifacts/attributes.adoc[] -:context: orchestrator-helm +:context: orchestrator-install :imagesdir: images -:title: Orchestrator flavor installation using Helm -:subtitle: Install, configure, and manage the Orchestrator flavor in {product} using Helm -:abstract: As a {product} ({product-very-short}) administrator, you can install and configure the Orchestrator flavor using Helm, ensuring your environment is prepared for workflow orchestration with {product}. +:title: Installing {product} with the Orchestrator plugin +:subtitle: Install, configure, and manage {product} with the Orchestrator plugin using Helm or the {product} Operator +:abstract: As a cluster administrator, you can install {product} ({product-very-short}) with the Orchestrator plugin. = {title} -//Helm-based +You can install {product} ({product-very-short}) using one of the following methods: + +* The {product} Operator +* The {product} Helm chart + +// Helm chart method include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] \ No newline at end of file From 575bdae5cc9ef4351cba06bd0e8c789730eaac87 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 19 Aug 2025 13:34:08 +0200 Subject: [PATCH 5/8] Installation process (Helm-based) for orchestrator --- assemblies/assembly-install-rhdh-orchestrator-helm.adoc | 2 +- .../proc-install-rhdh-with-orchestrator-helm-cli.adoc | 8 ++++---- .../proc-install-rhdh-with-orchestrator-helm-webui.adoc | 4 ++-- 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 fad87cef5d..dc46109fc2 100644 --- a/assemblies/assembly-install-rhdh-orchestrator-helm.adoc +++ b/assemblies/assembly-install-rhdh-orchestrator-helm.adoc @@ -10,7 +10,7 @@ endif::[] :context: install-rhdh-orchestrator-helm -You can install {product} with Orchestrator by using the {product} Helm chart. Orchestrator brings serverless workflows into Backstage, targets application migration to the cloud, onboarding of developers, and user-made workflows of Backstage actions or external systems. +You can install {product} with Orchestrator by using the {product} Helm chart. Orchestrator brings serverless workflows into {product-custom-resource-type}, targets application migration to the cloud, onboarding of developers, and user-made workflows of {product-custom-resource-type} actions or external systems. include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] 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 0a86b63038..7fa7a4ab0e 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -16,7 +16,7 @@ This is a one-off requirement and must be completed before enabling the Orchestr .Procedure -. As an administrator, install cluster-wide resources. +. As an administrator, install relevant cluster-wide resources. + [source,yaml] ---- @@ -82,11 +82,11 @@ orchestrator: + [NOTE] ==== -This only configures the Orchestrators use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in link:{configuring-book-url}#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. +This step only configures the Orchestrators use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in link:{configuring-book-url}#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. ==== .Verification -. Verify that the orchestrator plugin is visible in the {product} UI. +. Verify that the Orchestrator plugin is visible in the {product} UI. -. Create and run sample workflows to confirm orchestration is functioning correctly. \ No newline at end of file +. Create and run sample workflows to confirm the orchestration is functioning correctly. \ No newline at end of file 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 ad87694811..a0922290a1 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc @@ -5,13 +5,13 @@ You can install {product} ({product-very-short}) with the Orchestrator by using .Prerequisites -* You are logged in to the OpenShift Container Platform web console as a cluster administrator. +* You are logged in to the {ocp-short} web console as a cluster 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. .Procedure -. In the OpenShift web console, go to menu:Helm[Helm Charts]. +. In the {ocp-short} web console, go to menu:Helm[Helm Charts]. . Click btn:[Repository] and confirm that the {product} Helm chart repository is available. From 1ff78a86599eaec825930e24279b80d489382684 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 19 Aug 2025 16:50:09 +0200 Subject: [PATCH 6/8] Installation process (Helm-based) for orchestrator --- ...roc-install-rhdh-with-orchestrator-helm-cli.adoc | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) 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 7fa7a4ab0e..1203ce54bd 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -20,23 +20,20 @@ This is a one-off requirement and must be completed before enabling the Orchestr + [source,yaml] ---- -helm repo add bitnami https://charts.bitnami.com/bitnami -helm repo add backstage https://backstage.github.io/charts -helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart - -helm install redhat-developer/redhat-developer-hub-orchestrator-infra +helm repo add openshift-helm-charts https://charts.openshift.io/ +helm install openshift-helm-charts/redhat-developer-hub-orchestrator-infra ---- + [IMPORTANT] ==== -You must be a cluster administrator to install the `redhat-developer-hub-orchestrator-infra` Helm chart because it deploys cluster-scoped resources. The administrator manually approves the installed plans by setting the values of the Openshift Serverless and Openshift Serverless Logic Operators to `true.` +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. ==== . Install the Backstage chart with the orchestrator enabled as shown in the following example: + [source,yaml] ---- -helm install openshift-helm-charts/redhat-developer-hub --version 1.7.0 \ +helm install openshift-helm-charts/redhat-developer-hub --version {product-chart-version} \ --set orchestrator.enabled=true ---- @@ -62,7 +59,7 @@ global: [source,yaml] ---- helm install openshift-helm-charts/redhat-developer-hub \ - --version 1.7.0 \ + --version {product-chart-version} \ --set orchestrator.enabled=true \ --set orchestrator.serverlessOperator=false \ --set orchestrator.serverlessLogicOperator=false From 1459381cdb828257c0817ad094b151c323efa091 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 19 Aug 2025 17:42:53 +0200 Subject: [PATCH 7/8] Installation process (Helm-based) for orchestrator --- .../proc-install-rhdh-with-orchestrator-helm-cli.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 1203ce54bd..57372714cd 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -31,7 +31,7 @@ You must be a cluster administrator to install the `redhat-developer-hub-orchest . Install the Backstage chart with the orchestrator enabled as shown in the following example: + -[source,yaml] +[source,terminal,subs="attributes+"] ---- helm install openshift-helm-charts/redhat-developer-hub --version {product-chart-version} \ --set orchestrator.enabled=true @@ -56,7 +56,7 @@ global: . (Optional) You can disable the Serverless Logic and Serverless Operators individually or together by setting their values to `false`, as shown in the following example: + -[source,yaml] +[source,terminal,subs="attributes+"] ---- helm install openshift-helm-charts/redhat-developer-hub \ --version {product-chart-version} \ From 042a562732407129b5c21b2fc6dd8afeca555738 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 19 Aug 2025 18:02:46 +0200 Subject: [PATCH 8/8] Installation process (Helm-based) for orchestrator --- .../proc-install-rhdh-with-orchestrator-helm-cli.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 57372714cd..f8041bbeb4 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -3,9 +3,9 @@ :_mod-docs-content-type: PROCEDURE [id="proc-install-rhdh-with-orchestrator-helm-cli_{context}"] -= Installing {product} ({product-very-short}) on {ocp-short} with the Orchestrator using the Helm chart += Installing {product} ({product-very-short}) on {ocp-short} with the Orchestrator using the Helm CLI -You can install {product} ({product-very-short}) on {ocp-short} with the Orchestrator by using the Helm chart. The installation automatically enables the required dynamic plugins and integrates workflow infrastructure. +You can install {product} ({product-very-short}) on {ocp-short} with the Orchestrator by using the Helm CLI. The installation automatically enables the required dynamic plugins and integrates workflow infrastructure. .Prerequisites