FireHydrant logo

FireHydrant Plugin

View FireHydrant service incidents for your components directly in Backstage.

Created by FireHydrant

Getting started is simple

Don't want to spend your time installing and upgrading Backstage plugins? Get managed Backstage from Roadie.

Installation steps

Install the front-end plugin.

cd packages/app
yarn add @backstage/plugin-firehydrant

Add the FireHydrant card to the entity page.

// packages/app/src/components/catalog/EntityPage.tsx
import { FirehydrantCard } from '@backstage/plugin-firehydrant';
...
const overviewContent = (
  <Grid container spacing={3} alignItems="stretch">
    <Grid item md={6}>
      <FirehydrantCard />
    </Grid>
    <Grid item md={6}>
    ...

Add proxy configuration to the app-config.yaml.

# app-config.yaml
'/firehydrant/api':
  target: 'https://api.firehydrant.io/v1'
  changeOrigin: true
  headers:
    Authorization: Bearer fhb-d31e7e53c9c1bceba710eb17b4547549

Found a mistake? Update these instructions.

How it looks

FireHydrant in Backstage

Things to know

FireHydrant.io is an incident management tool with a variety of reliability management features including its own service catalog. Backstage components can be added to the FireHydrant service catalog.

Create service on FireHydrant.io

Typically, Backstage components are linked to external services like FireHydrant.io by adding annotations to the component’s catalog-info.yaml. The FireHydrant plugin does not require an annotation. Instead, the Backstage component is added to the FireHydrant.io service catalog following a very specific naming convention: component-type:namespace/component-name.

For example, a component of type Component, in the default namespace, named backstage-sample-service would need to be added to the FireHydrant.io service catalog as Component:default/backstage-sample-service. Here is what that component would loook like in the Backstage catalog:

Sample component in Backstage

And here is what the Matching component would look like in the FireHydrant.io service catalog:

Matching component in FireHydrant.io

Obtaining a FireHydrant Authorization Token

Backstage needs an authorization token to authenticate to the FireHydrant.io API. This token is obtained by created a new bot configuration on FireHydrant.io:

Create bot on FireHydrant.io, step 1

Add the authorization token directly to app-config.yaml or refer to it from an environment variable.

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.

We will never sell or share your email address.