As a prerequisite, you need to have configured the Incident.io catalog-importer to sync with your Backstage catalog. You can visit your incident.io dashboard to create a custom field that is powered by the Backstage Component catalog type.
We recommend creating a multi-select field called something like "Affected services" or "Impacted components".
Set up Backstage in minutes with Roadie
Focus on using Backstage, rather than building and maintaining it.
Installation steps
Install the plugin package in your Backstage app
yarn add --cwd packages/app @incident-io/backstageConfigure your proxy.
// app-config.yaml
proxy:
...
'/incident/api':
target: https://api.incident.io
headers:
Authorization: Bearer ${INCIDENT_API_KEY}And add any custom fields you have configured in incident.io in as well. If you have no custom fields you can omit this section, but if you do and they are not configued then the plugin will display an error.
incident:
fields:
api: "<id-of-api-custom-field>"
component: "<id-of-component-custom-field>"
system: "<id-of-system-custom-field>"
domain: "<id-of-domain-custom-field>"
- intro: Add the plugin cards to your entity page
language: typescrpipt
code: |Add cards to your entity pages
// packages/app/src/components/catalog/EntityPage.tsx
import { EntityIncidentCard } from "@incident-io/backstage";
<Grid item md={6}>
<EntityIncidentCard />
</Grid>Found a mistake? Update these instructions.
Things to know
Set up Backstage in minutes with Roadie
Focus on using Backstage, rather than building and maintaining it.