Skip to content

Commit ac922f1

Browse files
GitHub Actionsjmagak
GitHub Actions
authored and
jmagak
committed
Installation process (Helm-based) for orchestrator
1 parent bfa6255 commit ac922f1

6 files changed

+143
-167
lines changed

‎assemblies/assembly-install-rhdh-orchestrator-helm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ endif::[]
66
ifdef::context[]
77
[id="install-rhdh-orchestrator-helm_{context}"]
88
endif::[]
9-
= Installing {product} with the Orchestrator on OpenShift using Helm
9+
= Installing {product} with the Orchestrator plugin using Helm
1010

1111
:context: install-rhdh-orchestrator-helm
1212

13-
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.
13+
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.
1414

15-
include::modules/installation/proc-install-orchestrator-helm-cli.adoc[leveloffset=+1]
15+
include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1]
1616

17-
include::modules/installation/proc-install-orchestrator-helm-webui.adoc[leveloffset=+1]
17+
include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1]

‎modules/installation/proc-install-orchestrator-helm-cli.adoc

Lines changed: 0 additions & 118 deletions
This file was deleted.

‎modules/installation/proc-install-orchestrator-helm-webui.adoc

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
// Module included in the following assemblies
2+
// assembly-orchestrator-helm-modules.adoc
3+
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="proc-install-rhdh-with-orchestrator-helm-cli_{context}"]
6+
= Installing {product} ({product-very-short}) on {ocp-short} with the Orchestrator using the Helm chart
7+
8+
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.
9+
10+
.Prerequisites
11+
12+
* You are logged in as an administrator and have access to the {product} Helm chart repository.
13+
* You can install the necessary infrastructures resources, such as sonataflow, alongside {product-very-short} in the same namespace.
14+
+
15+
This is a one-off requirement and must be completed before enabling the Orchestrator plugin.
16+
17+
.Procedure
18+
19+
. As an administrator, install cluster-wide resources.
20+
+
21+
[source,yaml]
22+
----
23+
helm repo add bitnami https://charts.bitnami.com/bitnami
24+
helm repo add backstage https://backstage.github.io/charts
25+
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart
26+
27+
helm install <release_name> redhat-developer/redhat-developer-hub-orchestrator-infra
28+
----
29+
+
30+
[IMPORTANT]
31+
====
32+
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.`
33+
====
34+
35+
. Install the Backstage chart with the orchestrator enabled as shown in the following example:
36+
+
37+
[source,yaml]
38+
----
39+
helm install <release_name> openshift-helm-charts/redhat-developer-hub --version 1.7.0 \
40+
--set orchestrator.enabled=true
41+
----
42+
43+
. (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:
44+
+
45+
[source,yaml]
46+
----
47+
global:
48+
dynamic:
49+
plugins:
50+
- disabled: false
51+
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
52+
- disabled: false
53+
package: "./dynamic-plugins/dist/backstage-plugin-signals"
54+
- disabled: false
55+
package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
56+
- disabled: false
57+
package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
58+
----
59+
60+
. (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:
61+
+
62+
[source,yaml]
63+
----
64+
helm install <release_name> openshift-helm-charts/redhat-developer-hub \
65+
--version 1.7.0 \
66+
--set orchestrator.enabled=true \
67+
--set orchestrator.serverlessOperator=false \
68+
--set orchestrator.serverlessLogicOperator=false
69+
----
70+
71+
. (Optional) If you are using an external database, add the following configuration under `orchestrator.sonataflowPlatform` in your `values.yaml` file:
72+
+
73+
[source,yaml]
74+
----
75+
orchestrator:
76+
sonataflowPlatform:
77+
externalDBsecretRef: "<cred-secret>"
78+
externalDBName: "<database_name>" # The name of the user-configured existing database (Not the database that the orchestrator and sonataflow resources use).
79+
externalDBHost: "<database_host>"
80+
externalDBPort: "<database_port>"
81+
----
82+
+
83+
[NOTE]
84+
====
85+
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].
86+
====
87+
88+
.Verification
89+
90+
. Verify that the orchestrator plugin is visible in the {product} UI.
91+
92+
. Create and run sample workflows to confirm orchestration is functioning correctly.

‎modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[id="proc-install-rhdh-with-orchestrator-helm-webui.adoc_{context}"]
2+
= Install {product} ({product-very-short}) using {ocp-short} web console
3+
4+
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.
5+
6+
.Prerequisites
7+
8+
* You are logged in to the OpenShift Container Platform web console as a cluster administrator.
9+
* You have access to the {product} Helm chart repository.
10+
* Your cluster has internet access or the Helm charts are mirrored in a disconnected environment.
11+
12+
.Procedure
13+
14+
. In the OpenShift web console, go to menu:Helm[Helm Charts].
15+
16+
. Click btn:[Repository] and confirm that the {product} Helm chart repository is available.
17+
18+
. Search for the Orchestrator infrastructure for {product} and click btn:[Install].
19+
+
20+
[IMPORTANT]
21+
====
22+
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.
23+
====
24+
+
25+
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.
26+
27+
. Wait until they are successfully deployed.
28+
29+
. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases].
30+
31+
.Verification
32+
33+
After deployment completes:
34+
35+
* The orchestrator-related pods are running in the selected namespace.
36+
* Cluster-wide resources are present.
37+
* You can start connecting the orchestrator to your {product} UI.

‎titles/orchestrator/master.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
include::artifacts/attributes.adoc[]
2-
:context: orchestrator-helm
2+
:context: orchestrator-install
33
:imagesdir: images
4-
:title: Orchestrator flavor installation using Helm
5-
:subtitle: Install, configure, and manage the Orchestrator flavor in {product} using Helm
6-
: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}.
4+
:title: Installing {product} with the Orchestrator plugin
5+
:subtitle: Install, configure, and manage {product} with the Orchestrator plugin using Helm or the {product} Operator
6+
:abstract: As a cluster administrator, you can install {product} ({product-very-short}) with the Orchestrator plugin.
77

88
= {title}
99

10-
//Helm-based
10+
You can install {product} ({product-very-short}) using one of the following methods:
11+
12+
* The {product} Operator
13+
* The {product} Helm chart
14+
15+
// Helm chart method
1116
include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)