Skip to content

Commit d0f5655

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

File tree

8 files changed

+123
-0
lines changed

8 files changed

+123
-0
lines changed

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
ifndef::context[]
4+
[id="install-rhdh-orchestrator-helm"]
5+
endif::[]
6+
ifdef::context[]
7+
[id="install-rhdh-orchestrator-helm_{context}"]
8+
endif::[]
9+
= Installing {product} with Orchestrator using Helm
10+
11+
:context: install-rhdh-orchestrator-helm
12+
13+
You can install {product} with Orchestrator using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments.
14+
15+
include::modules/installation/proc-install-rhdh-orchestrator-helm.adoc[leveloffset=+1]

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

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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_{context}"]
6+
= Install Orchestrator Helm
7+
8+
You can install the Orchestrator flavor of {product} ({product-very-short}) on OpenShift using Helm charts, enabling serverless workflows and workflow orchestration capabilities.
9+
10+
.Prerequisites
11+
12+
* You are logged in as an administrator on the OpenShift cluster.
13+
* You have installed Helm and configured locally.
14+
* You have access to the {product} Helm chart repository.
15+
16+
.Procedure
17+
18+
. Add required Helm repositories:
19+
+
20+
[source,yaml]
21+
----
22+
helm repo add bitnami https://charts.bitnami.com/bitnami
23+
helm repo add backstage https://backstage.github.io/charts
24+
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart
25+
----
26+
27+
. Install the orchestrator infrastructure Helm chart:
28+
+
29+
[source,yaml]
30+
----
31+
helm install <release_name> redhat-developer/redhat-developer-hub-orchestrator-infra
32+
----
33+
34+
. Manually approve the Install Plans for OpenShift Serverless and Serverless Logic Operators and wait for deployment.
35+
36+
. Install the Backstage chart with the orchestrator enabled:
37+
+
38+
[source,bash]
39+
----
40+
helm install <release_name> redhat-developer/backstage --set orchestrator.enabled=true
41+
----
42+
43+
. To disable serverlessLogicOperator and serverlessOperator if managed externally:
44+
+
45+
[source,bash]
46+
47+
. (Optional) Enable Notifications and Signals plugins by adding the following to your values.yaml before installation or upgrade:
48+
+
49+
[source,yaml]
50+
----
51+
disabled: false
52+
package: "./dynamic-plugins/dist/backstage-plugin-notifications"
53+
54+
disabled: false
55+
package: "./dynamic-plugins/dist/backstage-plugin-signals"
56+
57+
disabled: false
58+
package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic"
59+
60+
disabled: false
61+
package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
62+
----
63+
64+
. (Optional) If using an external database, add the following configuration in your values.yaml:
65+
+
66+
[source,yaml]
67+
----
68+
externalDBsecretRef:
69+
externalDBName: "<database_name>"
70+
externalDBHost: "<database_host>"
71+
externalDBPort: "<database_port>"
72+
----
73+
74+
.Verification
75+
76+
. Verify that the orchestrator plugin is visible in the {product} UI.
77+
78+
. Test creating and executing workflows to confirm orchestration is functioning correctly.
79+
80+
. Check orchestrator pod logs to confirm successful workflow execution and plugin readiness.

‎titles/orchestrator/artifacts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../artifacts

‎titles/orchestrator/assemblies

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies

‎titles/orchestrator/docinfo.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<title>{title}</title>
2+
<productname>{product}</productname>
3+
<productnumber>{product-version}</productnumber>
4+
<subtitle>{subtitle}
5+
</subtitle>
6+
<abstract>
7+
<para>{abstract}</para>
8+
</abstract>
9+
<authorgroup>
10+
<orgname>{company-name} Customer Content Services</orgname>
11+
</authorgroup>
12+
<xi:include href="Common_Content/Legal_Notice.xml"
13+
xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/orchestrator/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

‎titles/orchestrator/master.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include::artifacts/attributes.adoc[]
2+
:context: orchestrator-helm
3+
: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}.
7+
8+
= {title}
9+
10+
//Helm-based
11+
include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1]

‎titles/orchestrator/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules

0 commit comments

Comments
 (0)