| id | title | sidebar_label | description |
|---|---|---|---|
software-templates-index |
Backstage Software Templates |
Overview |
The Software Templates part of Backstage is a tool that can help you create Components inside Backstage |
The Software Templates part of Backstage is a tool that can help you create Components inside Backstage. By default, it has the ability to load skeletons of code, template in some variables, and then publish the template to some locations like GitHub or GitLab.
Be sure to have covered Getting Started with Backstage before proceeding.
The Software Templates are available under /create. For local development you
should be able to reach them at http://localhost:3000/create.
Once there, you should see something that looks similar to this:
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.
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 is a destination URL to create for the
provider, for instance https://github.com/backstage/my-new-repository, or
https://gitlab.com/myorg/myrepo.
Once you've entered values and confirmed, you'll then get a popup box with live progress of what is currently happening with the creation of your template.
It shouldn't take too long, and you'll have a success screen!
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 in debugging.
When it's been created, you'll see the View in Catalog button, which will take
you to the registered component in the catalog:
And then you'll also be able to see it in the Catalog View table:
