Enable Orchestrator plugins

To use the Orchestrator, enable the Orchestrator plugins for Red Hat Developer Hub that are disabled by default.

Before you begin

  • You have installed the following operators:
    • OpenShift Serverless
    • OpenShift Serverless Logic (OSL)
  • (Optional) For managing the Orchestrator project, you have an instance of Argo CD or Red Hat OpenShift GitOps in the cluster. It is disabled by default.
  • (Optional) To use Tekton tasks and the build pipeline, you have an instance of Tekton or Red Hat OpenShift Pipelines in the cluster. These features are disabled by default.

About this task

Orchestrator-frontend plugin
backstage-plugin-orchestrator
Provides the interface for users to run and monitor workflows within RHDH. You can run and track the execution status of processes.
Orchestrator-backend plugin
backstage-plugin-orchestrator-backend
Gets workflow data into Developer Hub making sure RHDH processes critical workflow metadata and runtime status fulfilling your need for visibility.
Orchestrator-form-widget
backstage-plugin-orchestrator-form-widgets
Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows.
Orchestrator-scaffolder-backend-module
scaffolder-backend-module-orchestrator
Provides callable actions from Scaffolder templates, such as orchestrator:workflow:run or orchestrator:workflow:get_params. For more information about action outputs, see Orchestrator scaffolder action outputs.

Procedure

  1. Locate your Developer Hub configuration and enable the Orchestrator plugins and the supporting notification plugins.

    The {{inherit}} attribute in the package field automatically resolves to the default plugin version and configuration for your version of RHDH.

    plugins:
      - package: "oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator:{{inherit}}"
        enabled: true
      - package: "oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend:{{inherit}}"
        enabled: true
      - package: "oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-scaffolder-backend-module-orchestrator:{{inherit}}"
        enabled: true
      - package: "oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-form-widgets:{{inherit}}"
        enabled: true
      - package: ref://backstage-plugin-notifications
        enabled: true
      - package: ref://backstage-plugin-signals
        enabled: true
      - package: ref://backstage-plugin-notifications-backend
        enabled: true
      - package: ref://backstage-plugin-signals-backend
        enabled: true
    Note

    If you need a specific plugin version, replace {{inherit}} with the version tag, for example: oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator:1.3.0.

  2. Optional: Restrict where the Workflows tab appears.

    By default, the Workflows tab appears on all entity types. To display it only on specific entities, add the pluginConfig section with filtering conditions.

    plugins:
      - package: "oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator:{{inherit}}"
        enabled: true
        pluginConfig:
          dynamicPlugins:
            frontend:
              red-hat-developer-hub.backstage-plugin-orchestrator:
                appIcons:
                  - importName: OrchestratorIcon
                    name: orchestratorIcon
                dynamicRoutes:
                  - importName: OrchestratorPage
                    menuItem:
                      icon: orchestratorIcon
                      text: Orchestrator
                      textKey: menuItem.orchestrator
                    path: /orchestrator
                entityTabs:
                  - path: /workflows
                    title: Workflows
                    titleKey: catalog.entityPage.workflows.title
                    mountPoint: entity.page.workflows
                mountPoints:
                  - mountPoint: entity.page.workflows/cards
                    importName: OrchestratorCatalogTab
                    config:
                      layout:
                        gridColumn: 1 / -1
                      if:
                        anyOf:
                          - IsOrchestratorCatalogTabAvailable

    Where:

    IsOrchestratorCatalogTabAvailable
    A condition function exported by the Orchestrator plugin that checks whether the entity has workflow-related data or annotations.
    layout.gridColumn
    Controls the grid layout positioning. The value 1 / -1 spans the full width of the grid.
    if.anyOf

    Specifies that the tab appears if any of the listed conditions are met. Add conditions like isKind: component to further restrict where the tab appears.

    Important

    Make sure the indentation is correct: if must be at the same level as layout under config, and conditions under anyOf must be indented two more levels. Incorrect indentation can cause the Workflows tab to appear on all entity types, including User and Group entities.

    To restrict the Workflows tab to only Component entities, modify the if condition:

                      if:
                        allOf:
                          - IsOrchestratorCatalogTabAvailable
                          - isKind: component