Skip to content

Backstage Software Template to generate a new project with a Devfile using `odo`

Notifications You must be signed in to change notification settings

ododev/odo-backstage-software-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 

Repository files navigation

odo-backstage-software-template

This is a Software Template for Backstage that allows users to pick a Devfile Stack from a configured Devfile Registry. It then generates and publishes a starter project to a GitHub repository, and finally registers the new entity into the Backstage catalog.

It does so by leveraging both the DevfileSelectorExtension Custom Field extension and the devfile:odo:* Custom Actions available at https://github.com/redhat-developer/backstage-odo-devfile-plugin.

Demo

Screencast.from.2023-11-07.10-38-31.webm

Usage

  1. Follow the instructions to set up and register the devfile-field-extension Custom Field extension into your Backstage instance: https://github.com/redhat-developer/backstage-odo-devfile-plugin/blob/main/packages/devfile-field-extension/README.md
  2. Follow the instructions to set up and register the scaffolder-odo-actions Custom Actions into your Backstage instance: https://github.com/redhat-developer/backstage-odo-devfile-plugin/blob/main/packages/scaffolder-odo-actions-backend/README.md
  3. Register this Template into the app-config.yaml of your Backstage instance, and optionally configure the odo plugin:
# app-config.yaml

catalog:
  locations:
    # [...]
    - type: url
      target: https://github.com/ododev/odo-backstage-software-template/blob/main/template.yaml
      rules:
        - allow: [Template]

# Optional configuration for the odo plugin
odo:
  telemetry:
    # Disable the odo telemetry. False by default.
    disabled: false
  1. Restart your Backstage instance, and you should see a new Bootstrap application with Devfile Template available if you click on the Create button.

About

Backstage Software Template to generate a new project with a Devfile using `odo`

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published