PagerDuty

View the on-call schedules, on-call participants as well as ability to create an incident directly with PagerDuty to enrich the operational engagement of your services within the catalog.

Summary - Creating a PagerDuty Credential

Create an API key. Copy the key to a secure location.
Go to configure8 app -> Settings -> Credentials -> Add Credential and select PagerDuty credential provider.
Set up name for the Credential and fill info based on this.
Hit Save. The credentials will be checked and a discovery job will start. Done!
You can now add it as a Plugin for your services.

World-class organizations use PagerDuty* as a DevOps best practice to enforce accountability and service quality at scale. With intuitive, flexible scheduling and escalations, PagerDuty On-Call Management makes it simple to distribute on-call responsibilities across teams, so you can ensure the exact right people are notified when time is on the line.

Prerequisite

In order to get started with embedding your PagerDuty integration, you must create a new API key.

You can review the full instructions for creating new API keys here.

Generate API Key

API keys are unique to your organization. PagerDuty offers a REST API Access Key that allows third parties to interact with configuration data in your account.

Admins and Account Owners can create, disable, enable and delete general access REST API keys.

To generate an API Access Key, login to your PagerDuty console and:

In the web app, navigate to Integrations API Access Keys.
Click Create New API Key.
Enter a Description to help you identify the key later.
Click Create Key.

This will generate a unique API key. Store it in a secure location, as this is the only time the key is displayed in full. If you lose a key you will need to delete it and create a new one.

Creating a PagerDuty Credential

To connect your PagerDuty account to configure8, perform the following steps.

Get started by navigating to the Credentials page by clicking on the "lock" icon on the menu bar.

Next, select the Add Credential button.

From the Add Credential pop-up, select PagerDuty from the list of available providers.

Next, enter the information required for your credential

Name: a recognizable alias for the new credential
Account ID: This is the name of your PagerDuty account/ sub account if your organization has multiple accounts. For example, if your URL when logging into PagerDuty is "organization.pagerduty.com", you would enter "organization" as the account ID.
API Key: This is the PagerDuty API Key you generated in the prerequisite section.

Select Save to create your PagerDuty credential in configure8. The configure8 app will automatically validate the credentials to make sure they work. If they do not, the credentials will not be saved and you will be prompted to fix them.

Configuring PagerDuty for your Services

Adding a PagerDuty plug-in to your service adds the on-call schedule and ability to create an incident to the sidebar on your service overview page. To add a PagerDuty plug-in to your service, start by selecting a service from your catalog Services listing.

From your service overview page, select the Add Plug-in button.

From the Plugins dialog, browse through the list of available plugins and select the PagerDuty plug-in by clicking on the Add button.

In the Plug-ins configuration wizard, select an existing credential to connect to the selected plugin provider. If you do not have an existing credential or would like to use a new credential, select the Add Credential button.

Next, enter the information required for your PagerDuty plug-in configuration.

Plugin Title: the title of the plug-in to display on the service overview page
Schedule identifier: This is the team schedule you would like to link to your service. configure8 will query PagerDuty for you and return the available schedules based on the API Key provided for you to easily select your desired schedule.

Once you have entered all the required configuration information, select Done. Your configured plug-in is added to your service overview page.

Creating an incident

From your service overview page, find you PagerDuty plugin and click on the New Incident button.

Next, enter the information required for your incident configuration.

From: the user which creates an incident. configure8 will query PagerDuty for you and return the available users that are related to the account API key is provided for.
Title: Incident name.
Impacted Service: service an incident relates to.
Priority
Details: incident description.