Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

RHDH Orchestrator Templates

Example Software Templates for Red Hat Developer Hub (RHDH) that trigger Orchestrator workflows via the orchestrator:workflow:run scaffolder action.

Templates

Template File Workflow ID Description
Run Greeting Workflow templates/greeting-workflow-template.yaml greet Sends a personalized greeting in English or Spanish
Create GitHub Repository templates/github-workflow-template.yaml github Creates a new GitHub repository via Orchestrator
Send Slack Notification templates/slack-workflow-template.yaml slack Sends a message to a Slack channel

Workflow Definitions (SonataFlow)

The workflows/ directory contains the corresponding SonataFlow workflow definitions (Serverless Workflow specification):

Workflow File Spec Version
Greeting workflows/greeting.sw.yaml 0.8
GitHub workflows/github.sw.yaml 0.8
Slack workflows/slack.sw.yaml 0.8

How to Use

Prerequisites

  • A running RHDH instance with the Orchestrator plugin enabled
  • SonataFlow running and accessible from RHDH
  • The scaffolder backend module for Orchestrator installed (@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic)

Option 1: Import via Catalog Import UI

  1. Navigate to your RHDH instance: https://<your-rhdh-host>/catalog-import
  2. Import each template using its raw GitHub URL:
https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/greeting-workflow-template.yaml
https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/github-workflow-template.yaml
https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/slack-workflow-template.yaml
  1. For each URL: click Analyze, then Import.

Option 2: Add to app-config.yaml

Add the templates to your RHDH app-config.yaml under catalog.locations:

catalog:
  locations:
    - type: url
      target: https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/greeting-workflow-template.yaml
      rules:
        - allow: [Template]
    - type: url
      target: https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/github-workflow-template.yaml
      rules:
        - allow: [Template]
    - type: url
      target: https://github.com/ShiranHi/rhdh-orchestrator-templates/blob/main/templates/slack-workflow-template.yaml
      rules:
        - allow: [Template]

Verify

After importing, the templates should appear on the Create page (/create) of your RHDH instance. Triggering a template will execute the corresponding Orchestrator workflow, and results can be viewed on the Orchestrator page (/orchestrator).

Repository Structure

.
├── templates/                          # Backstage Software Templates
│   ├── greeting-workflow-template.yaml # Greeting workflow template
│   ├── github-workflow-template.yaml   # GitHub repo creation template
│   └── slack-workflow-template.yaml    # Slack notification template
├── workflows/                          # SonataFlow workflow definitions
│   ├── greeting.sw.yaml               # Greeting workflow
│   ├── github.sw.yaml                 # GitHub workflow
│   └── slack.sw.yaml                  # Slack workflow
└── README.md

License

These examples are provided as-is for demonstration purposes.

About

Example Backstage Software Templates for RHDH Orchestrator workflows (Greeting, GitHub, Slack)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors