From 48ca39876e9296a23e6dd51b7abd0ee34880583f Mon Sep 17 00:00:00 2001 From: Doug Szumski Date: Thu, 2 May 2019 09:47:39 +0100 Subject: [PATCH] Add PagerDuty notification plugin documentation Story: 2005551 Task: 30699 Change-Id: I111e9923ceb12f364febf33c0b59bdbdac53d5fe --- README.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 56ba208..722e5c5 100644 --- a/README.rst +++ b/README.rst @@ -139,7 +139,7 @@ The following notification plugins are available: - Email - HipChat - Jira -- Pagerduty +- PagerDuty - Slack - Webhook @@ -150,6 +150,23 @@ general you will need to follow these steps to enable a plugin: - Make sure that the plugin is configured in the config file - Restart the Monasca Notification service +PagerDuty plugin +---------------- + +The PagerDuty plugin supports the PagerDuty v1 Events API. The first step +is to `configure`_ a service in PagerDuty which uses this API. Once +configured, the service will be assigned an integration key. This key should be +used as the `ADDRESS` field when creating the notification type, for example: + +:: + + monasca notification-create pd_notification pagerduty a30d5560c5ce4239a6f52a01a15850ca + +The default settings for the plugin, including the v1 Events API URL should +be sufficient to get started, but it is worth checking that the PagerDuty +Events v1 API URL matches that provided in the example Monasca Notification +config file. + Slack plugin ~~~~~~~~~~~~ @@ -238,3 +255,5 @@ Future Considerations .. _webhook: https://api.slack.com/incoming-webhooks .. _deprecated: https://api.slack.com/custom-integrations/legacy-tokens + +.. _configure: https://support.pagerduty.com/docs/services-and-integrations#section-events-api-v1