19min

Installation

The Rootly plugin is a frontend plugin that displays Rootly services, incidents in Backstage and can be found here: https://github.com/rootlyhq/backstage-plugin. The plugin includes three components that can be integrated into Backstage:

  • The RootlyPage routable extension component which produces a standalone page with the following capabilities:
    • View and search a list of entities and import/link them to rootly services
    • View and search a list of services
    • View and search a list of incidents
  • The RootlyOverviewCard component which produces a summary of your entity with incidents over last 30 days and ongoing incidents.
  • The RootlyIncidentsPage component which produces a dedicated page within your entity with details about ongoing and past incidents.

Creating an Rootly API key

Because of the features provided by the plugin, an API key with full access to your Rootly domain is required.

  • Read access on services is needed to list services, write access to link entities to services.
  • Read access on incidents needed to list incidents.
  1. Go to Profile -> Manage API Keys.
  2. Click on Generate New API Key button.
  3. Copy the key.

Backstage Setup

Add the plugin to your frontend app:

Text
|

Configure the plugin in app-config.yaml. The proxy endpoint described below will allow the frontend to authenticate with Rootly without exposing your API key to users.

YAML
|

Global

RootlyPage component

Document image
Document image
Document image

Expose the Rootly global page:

JS
|

Add a link to the sidebar:

JS
|

Entity

RootlyOverviewCard component

Document image
JS
|

RootlyIncidentsPage component

Document image
JS
|

Support

If you need help or more information about this integration, please contact support@rootly.com or use the lower right chat widget to get connected with an engineer.



Updated 21 Jun 2022
Did this page help?
Yes
No