Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.03 KB

File metadata and controls

59 lines (37 loc) · 2.03 KB

Software Templates

The Software Templates part of Backstage is a tool that can help you create Components inside Backstage. It by default has the ability to load skeletons of code, template in some variables and then publish the template to some location like GitHub.

Getting Started

The Software Templates are available under /create, and if you've followed Getting Started with Backstage, you should be able to reach http://localhost:3000/create.

You should get something that looks similar to this:

Create Image

Choose a template

When you select a template that you want to create, you'll be taken to the next page which may or may not look different for each template. Each template can ask for different input variables, and they are then passed to the templater internally.

Enter some variables

After filling in these variables, you'll get some more fields to fill out which are required for backstage usage. The owner, which is a user in the backstage system, and the storePath which right now must be a Github Organisation and a non-existing github repository name in the format organistaion/reponame.

Enter backstage vars

Run!

Once you've entered values and confirmed, you'll then get a modal with live progress of what is currently happening with the creation of your template.

Templating Running

It shouldn't take too long, and you'll have a success screen!

Templating Complete

If it fails, you'll be able to click on each section to get the log from the step that failed which can be helpful to debug.

Templating failed

View Component in Catalog

When it's been created you'll see the View in Catalog button, which will take you to the registered component in the catalog:

Catalog

And then you'll also be able to see it in the Catalog View table

Catalog