The PagerDuty Backstage plugin allows Roadie Backstage users to:
- See who is on call for a particular catalog Component.
- See if there are active incidents for a given catalog Component.
- Create new incidents from Backstage.
In order to use the PagerDuty plugin, Roadie needs an API token to communicate with it’s APIs.
This page describes how to create and set up the API token.
Inside PagerDuty, access “API Access Keys” inside the “Integrations” menu.
On the API Access Keys page, click the “Create New API Key” button.
Set a sensible description and click “Create Key”.
ℹ️ The PagerDuty Backstage plugin allows users to create PagerDuty incidents from within Backstage. For this reason, the API key needs both read and write permissions to function correctly.
Copy the key that is created to your clipboard.
Visit the following URL and enter the API Key value from above into
ℹ️ Roadie accepts the token from PagerDuty unmodified. The configuration steps for the PagerDuty plugin in self-hosted Backstage are more complex, and will not work in Roadie.
Backstage requires a PagerDuty annotation on every component which will display the PagerDuty plugin. The annotation key is
This example shows how it might look on a Backstage component:
apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: sample-service title: Sample Service description: A sample service annotations: pagerduty.com/integration-key: <sample-service-integration-key> spec: type: service owner: sample-team lifecycle: experimental
To generate the PagerDuty integration key, find a “Service” in the PagerDuty Service Directory and view the Integrations tab.
Click the Add an integration link. Choose Events API V2, and click the Add button.
You should now be redirected back to the Integrations tab, and a new integration should have been created. You can edit the integration name to indicate that this is a Roadie Backstage integration.
Copy the Integration Key and add it to the Component YAML.
apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: sample-service title: Sample Service description: A sample service annotations: pagerduty.com/integration-key: c5dd2b278fdc4d01d0a4a02b25c1ccc1 spec: type: service owner: sample-team lifecycle: experimental
Commit and merge this change and the Roadie Backstage PagerDuty plugin should begin working shortly afterwards.