Skip to content

Commit d4aaecd

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

File tree

4 files changed

+163
-83
lines changed

4 files changed

+163
-83
lines changed

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

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

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

13-
You can install {product} with Orchestrator by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments.
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.
1414

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

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

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
// Module included in the following assemblies
2+
// assembly-orchestrator-helm-modules.adoc
3+
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="proc-install-orchestrator-helm-cli_{context}"]
6+
= Install the Orchestrator flavor using the Helm CLI
7+
8+
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.
9+
10+
11+
[IMPORTANT]
12+
====
13+
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.
14+
====
15+
16+
.Prerequisites
17+
18+
* You are logged in to the OpenShift cluster using the `oc` CLI.
19+
* You have installed Helm and configured locally.
20+
* You have access to the official Red Hat container registry (`registry.redhat.io`).
21+
* You have created a `values.yaml` file for the deployment.
22+
* You have access to the {product} Helm chart repository.
23+
24+
.Procedure
25+
26+
. Add the official OpenShift Helm charts repository:
27+
+
28+
[source,bash]
29+
----
30+
helm repo add openshift-helm-charts https://charts.openshift.io/
31+
helm repo update
32+
----
33+
34+
. Install the orchestrator infrastructure Helm chart:
35+
+
36+
[source,bash]
37+
----
38+
helm install <release_name> openshift-helm-charts/redhat-developer-hub-orchestrator-infra
39+
----
40+
41+
. Manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. Wait until they are successfully deployed.
42+
43+
. Install the Backstage chart with the orchestrator enabled:
44+
+
45+
[source,bash]
46+
----
47+
helm install <release_name> openshift-helm-charts/redhat-developer-hub --version 1.7.0 \
48+
--set orchestrator.enabled=true
49+
----
50+
51+
. (Optional) Disable the installation of the Serverless Logic and Serverless Operators if they are managed externally:
52+
+
53+
[source,bash]
54+
----
55+
helm install <release_name> redhat-developer/backstage \
56+
--set orchestrator.serverlessOperator=false \
57+
--set orchestrator.serverlessLogicOperator=false
58+
----
59+
60+
. (Optional) Enable *Notifications* and *Signals* plugins by adding them under `global.dynamic.plugins` in your `values.yaml` file:
61+
+
62+
[source,yaml]
63+
----
64+
global:
65+
dynamic:
66+
plugins:
67+
- disabled: false
68+
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
69+
- disabled: false
70+
package: "./dynamic-plugins/dist/backstage-plugin-signals"
71+
- disabled: false
72+
package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
73+
- disabled: false
74+
package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
75+
----
76+
77+
. (Optional) If using an external database, add the following configuration under `orchestrator.sonataflowPlatform` in your `values.yaml` file:
78+
+
79+
[source,yaml]
80+
----
81+
orchestrator:
82+
sonataflowPlatform:
83+
externalDBsecretRef: "<cred-secret>"
84+
externalDBName: "<database_name>"
85+
externalDBHost: "<database_host>"
86+
externalDBPort: "<database_port>"
87+
----
88+
89+
[NOTE]
90+
====
91+
This only configures the Orchestrator's use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in:
92+
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].
93+
====
94+
95+
.Verification
96+
97+
. Verify that the orchestrator plugin is visible in the {product} UI.
98+
99+
. Create and run sample workflows to confirm orchestration is functioning correctly.
100+
101+
. Check the logs of the Orchestrator pod to verify workflow execution and plugin readiness.
102+
Use the following commands to check the Orchestrator pod logs:
103+
+
104+
[source,bash]
105+
----
106+
# List pods in the namespace
107+
oc get pods -n <namespace>
108+
109+
# Replace <orchestrator-pod-name> with the actual pod name
110+
oc logs -n <namespace> <orchestrator-pod-name>
111+
----
112+
113+
. (Optional) Stream logs in real-time:
114+
+
115+
[source,bash]
116+
----
117+
oc logs -n <namespace> -f <orchestrator-pod-name>
118+
----

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[id="proc-install-orchestrator-helm-webui_{context}"]
2+
= Install the Orchestrator flavor using the OpenShift web console
3+
4+
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.
5+
6+
[IMPORTANT]
7+
====
8+
You must be a cluster administrator to install the Orchestrator Helm chart because it deploys cluster-scoped resources.
9+
====
10+
11+
.Prerequisites
12+
13+
* You are logged in to the OpenShift Container Platform web console as a cluster administrator.
14+
* You have access to the {product} Helm chart repository.
15+
* Your cluster has internet access or the Helm charts are mirrored in a disconnected environment.
16+
17+
.Procedure
18+
19+
. In the OpenShift web console, go to menu:Helm[Helm Charts].
20+
21+
. Click btn:[Repository] and confirm that the {product} Helm chart repository is available. If not, add it manually.
22+
23+
. Search for the Orchestrator Helm chart and click btn:[Install].
24+
25+
. In the install form:
26+
* Choose or create a target namespace.
27+
* Accept or modify the default values as needed.
28+
* Review and confirm the cluster-scoped resources that the chart will install.
29+
30+
. Click btn:[Install] to deploy the chart.
31+
32+
. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases].
33+
34+
.Verification
35+
36+
After deployment completes:
37+
38+
* The orchestrator-related pods should be running in the selected namespace.
39+
* Cluster-wide resources such as CustomResourceDefinitions (CRDs) should be present.
40+
* You can begin connecting the orchestrator to your {product} UI.

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

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

0 commit comments

Comments
 (0)