Roadie supports many open-source Backstage plugins out of the box. This tutorial will show you how to add a plugin to Roadie.
We will use PagerDuty in this example, but the process is broadly similar for most plugins.
See the sidebar for a full list of supported plugins, and dedicated instructions for each one.
You must be an admin in Roadie. By default, all users are admins. Learn how to designate certain users as admins here.
Most plugins make available a Tab or Card which must be added to the Roadie interface.
Let’s add the PagerDuty Card to the Component Overview page.
- Visit the Overview page of a Component in your catalog and click the gear icon in the top right corner.
- Click the plus icon to add a component.
- Search for “EntityPagerDutyCard” in the dialog which appears and click “ADD”.
- The PagerDuty card should appear in the interface. Drag it to wherever you would like it to appear.
- Click the floppy disk icon in the top right to save your changes.
As you can see, the PagerDuty card is complaining about a missing or invalid token. It cannot access the PagerDuty API without authentication. Let’s set a token now.
Visit the secrets page in Roadie. Here’s how.
Scroll down to find PAGERDUTY_TOKEN in the UI.
- Click the pencil icon to open a dialog where you can set a token. Click SAVE. Please visit the dedicated PagerDuty plugin docs to learn where to get this token from.
Once the token is set, we should see something different when we return to the component page. We’re not there yet but we’re closer!
For the plugin to work for a component, we need to tell Backstage how to map the service in PagerDuty to the Component in Roadie Backstage.
- Open the
catalog-info.yamlfile for the component in question in your text editor.
- Add the PagerDuty annotation. Please visit the dedicated PagerDuty plugin docs to learn where to get this “integration-key”.
apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: sample-service-1 title: Sample Service 1 description: | A service for testing Backstage functionality. Configured for GitHub Actions. annotations: pagerduty.com/integration-key: 78743832u48973894798 spec: type: service owner: my-team-name lifecycle: production
It can take a few minutes for Backstage to find and ingest this new value. Once it does, you should see the PagerDuty card render correctly in Roadie Backstage.
That’s it! Now any service can correctly display information from PagerDuty simply by adding the annotation.
Now that you have things set up, why not invite a colleague to check out Roadie Backstage.