Setting up your catalog
Install the GitHub App
Installing the GitHub App will allow Roadie to access the YAML metadata files that Backstage needs to operate. Learn more about the permissions required.
- Click the Administration link in the bottom left of the application.
- Click the Settings tab along the top of the Administration page and then GitHub under Integrations in the left sidebar
- Open the GitHub accordion and click “Add GitHub App”
- Choose your GitHub organization and follow the steps to install the app.
Upload a catalog item to a repository
In one of the GitHub repos in your project create a catalog-info.yaml with the contents shown in the panel on the right.
Import the catalog file
Copy the URL of the catalog file you created by visiting the file in your browser and copying the url from the location bar. The URL may look like this: https://github.com/<org-name>/<repo-name>/blob/<branch-name>/catalog-info.yaml.
Visit the import page in Roadie. https://<your tenant>.roadie.so/import/entity, and paste the URL into the box. Click analyze and then import.
Now you can click on the entity link to visit the entity that you have just created.
Next Steps
- Configure auto-discovery so that Roadie can automatically discover and import catalog-info.yaml files.
- Use a scaffolder template to give users a streamlined interface that they can use to generate the YAML file you used earlier in this tutorial.
- Add a TechDocs page to the component you now have in the catalog.
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: artist-web
description: The place to be, for great artists
spec:
type: website
lifecycle: production
owner: artist-relations-team
system: artist-engagement-portal
dependsOn:
- resource:default/artists-db
providesApis:
- artist-api