Automate workflow deployments

Automate the software development lifecycle for serverless workflows by using Orchestrator software templates to bootstrap complete workflow projects with Git repositories, deployment configurations, and CI/CD pipelines.

Deploy Red Hat Developer Hub for workflow automation

To automate CI/CD pipeline setup, deploy Red Hat Developer Hub with workflow orchestration by using predefined Operator configurations.

Before you begin

Procedure

  1. Create a namespace for your Red Hat Developer Hub instance or use an existing namespace:
    $ oc new-project my-rhdh-project
  2. Create a Backstage CR with the Orchestrator deployment configuration:
    $ cat <<EOF | oc -n my-rhdh-project create -f -
    apiVersion: rhdh.redhat.com/v1alpha5
    kind: Backstage
    metadata:
      name: <backstage_instance_name>
    spec:
      flavours:
        - name: orchestrator
          enabled: true
    EOF

    Where:

    <backstage_instance_name>
    A name for your Red Hat Developer Hub instance, for example developer-hub-orchestrator.
    spec.flavours
    The pre-configured settings array. Set name: orchestrator with enabled: true to automatically configure workflow orchestration capabilities.
    Note

    This example uses the default local PostgreSQL database. For production deployments, Red Hat recommends using an external PostgreSQL database. If you configured an external database in the prerequisites, add the database configuration to the CR as shown in Configure external PostgreSQL database.

  3. Wait for the Operator to reconcile the Backstage CR:
    $ oc get backstage <backstage_instance_name> -n my-rhdh-project -w

    The deployment is ready when the PHASE column shows Deployed.

Results

  1. Verify that the Data Index service pod is running:
    $ oc get pods -n my-rhdh-project | grep sonataflow

    You should see the Data Index service pod. The Orchestrator backend plugin runs within the main Red Hat Developer Hub pod.

  2. Access the Red Hat Developer Hub UI:
    $ oc get route backstage-<backstage_instance_name> -n my-rhdh-project -o jsonpath='{.spec.host}'

    Go to the URL in your browser.

  3. Verify the Orchestrator plugin is displayed in the Red Hat Developer Hub navigation menu. Look for the Orchestrator option in the left navigation panel.
  4. Optional: Test workflow deployment by creating a sample workflow. For detailed workflow examples, see workflow examples.
If workflow pods fail to start

Verify the PostgreSQL connection by checking the Operator logs:

$ oc logs -n openshift-operators deployment/rhdh-operator -c manager

Ensure the database credentials in the Secret are correct and the database is accessible from the cluster.

If the Data Index service fails
Verify that the PostgreSQL user has permissions to create schemas and tables. The Orchestrator deployment configuration automatically initializes required database schemas.

Workflow deployment components

The Orchestrator plugin integrates several components to automate the software development lifecycle for serverless workflows.

Note

Use the rhdh namespace where the RHDH chart is installed.

The Orchestrator plugin integrates these components:

RHDH Helm chart
Installs the RHDH Orchestrator.
Tekton or Red Hat OpenShift Pipelines
Manages the Kubernetes-native CI pipeline to build images.
ArgoCD or Red Hat OpenShift GitOps
Manages the CD pipeline to deploy the workflow on the RHDH instance.
Quay.io
Stores the container images generated by the pipelines.
OpenShift Serverless Logic operator
Implements serverless workflow specifications