Procedure

1. Add the official OpenShift Helm charts repository:

   helm repo add openshift-helm-charts https://charts.openshift.io/
   helm repo update

2. Install the orchestrator infrastructure Helm chart:

   helm install <release_name> openshift-helm-charts/redhat-developer-hub-orchestrator-infra

3. Manually approve the install plans for OpenShift Serverless and Serverless Logic Operators. Wait until they are successfully deployed.

4. Install the Backstage chart with the orchestrator enabled:

   helm install <release_name> openshift-helm-charts/redhat-developer-hub --version 1.7.0 \
     --set orchestrator.enabled=true

5. (Optional) Disable the installation of the Serverless Logic and Serverless Operators if they are managed externally:

   helm install <release_name> redhat-developer/backstage \
     --set orchestrator.serverlessOperator=false \
     --set orchestrator.serverlessLogicOperator=false

6. (Optional) Enable Notifications and Signals plugins by adding them under global.dynamic.plugins in your values.yaml file:

   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"

7. (Optional) If using an external database, add the following configuration under orchestrator.sonataflowPlatform in your values.yaml file:

   orchestrator:
     sonataflowPlatform:
       externalDBsecretRef: "<cred-secret>"
       externalDBName: "<database_name>"
       externalDBHost: "<database_host>"
       externalDBPort: "<database_port>"

Verification

1. Verify that the orchestrator plugin is visible in the Red Hat Developer Hub UI.
2. Create and run sample workflows to confirm orchestration is functioning correctly.

3. Check the logs of the Orchestrator pod to verify workflow execution and plugin readiness. Use the following commands to check the Orchestrator pod logs:

   # List pods in the namespace
   oc get pods -n <namespace>
   
   # Replace <orchestrator-pod-name> with the actual pod name
   oc logs -n <namespace> <orchestrator-pod-name>

4. (Optional) Stream logs in real-time:

   oc logs -n <namespace> -f <orchestrator-pod-name>

Procedure

1. In the OpenShift web console, go to menu:Helm[Helm Charts].
2. Click btn:[Repository] and confirm that the Red Hat Developer Hub Helm chart repository is available. If not, add it manually.
3. Search for the Orchestrator Helm chart and click btn:[Install].

4. 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.
5. Click btn:[Install] to deploy the chart.
6. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases].