config.yaml

---
cog_bundle_version: 4

name: pagerduty
version: 0.1.0
description: Interact with pagerduty
long_description: |
  The pagerduty bundle can be configured with a few env vars. All
  commands require PAGERDUTY_ACCOUNT_SUBDOMAIN and
  PAGERDUTY_ACCOUNT_TOKEN to be set.  That would be the subdomain for
  your PagerDuty account and the V1 API token respectively.

  The alert command has an optional var, PAGERDUTY_DEFAULT_SERVICE_KEY.
  This is the integration key found on the integration tab for the
  service on PagerDuty's web UI. If set, any alerts that don't specify a
  service will be sent here. Note that if the service key is not set or
  a service isn't passed to the command, it will fail.

  Commands ack and resolve have a couple extra vars.
  PAGERDUTY_DEFAULT_EMAIL, similar to PAGERDUTY_DEFAULT_SERVICE_KEY,
  will be used as the requester when acking or resolving incidents.
  Additionally, you may attach the requester to cog accounts. Using vars
  in the form, PAGERDUTY_EMAIL_FOR_<COG_USER> you can specify which
  PagerDuty email is associated with which Cog user.  So for example, if
  your Cog username is 'bob', you would set the var
  PAGERDUTY_EMAIL_FOR_BOB. Then whenever you ack or resolve the proper
  PagerDuty account is associated with the action.
author: Matthew Peck <matt@operable.io>
homepage: https://github.com/cogcmd/pagerduty
docker:
  image: cogcmd/pagerduty
  tag: 0.1.0
permissions:
  - pagerduty:read
  - pagerduty:write
  - pagerduty:alert
commands:
  alert:
    executable: /home/bundle/cog-command
    description: Trigger alerts
    arguments: "<message>"
    long_description: |
      Returns a confirmation message on success

      Requires the following environment variables:

        PAGERDUTY_ACCOUNT_SUBDOMAIN
        PAGERDUTY_ACCOUNT_TOKEN

      Behavior is configured by the following environment variables:

        PAGERDUTY_DEFAULT_SERVICE_KEY
          If no service is passed, this is the id of the service to use.
    notes: If no service is passed and the default service key is not set, the command will fail.
    rules:
      - must have pagerduty:alert
    options:
      service:
        type: string
        required: false
        short_flag: s
  oncall:
    executable: /home/bundle/cog-command
    description: Find out who is on-call for all services, or for a specific service
    long_description: |
      Requires the following environment variables:

        PAGERDUTY_ACCOUNT_SUBDOMAIN
        PAGERDUTY_ACCOUNT_TOKEN
    arguments: "[service]"
    rules: ["allow"]
  ack:
    executable: /home/bundle/cog-command
    description: Acknowledge incidents
    long_description: |
      Returns confirmation of acknowledgement

      Requires the following environment variables:

        PAGERDUTY_ACCOUNT_SUBDOMAIN
        PAGERDUTY_ACCOUNT_TOKEN

      Behavior is configured by the following environment variables:

        PAGERDUTY_DEFAULT_EMAIL
          The default pagerduty email to acknowledge incidents as

        PAGERDUTY_EMAIL_FOR_<COG_USER>
          Used to map cog users to pagerduty emails

      An email mapping to a pagerduty account is required in order to
      ack incidents. If the '--as' option has been specified then that
      email will be used. If not this command will first look for an
      environment variable in the form of
      'PAGERDUTY_EMAIL_FOR_<COG_USER>', so if your user name is 'bob',
      the env var will be 'PAGERDUTY_EMAIL_FOR_BOB', and use that email
      to acknowledge the incident. If that fails it will try
      'PAGERDUTY_DEFAULT_EMAIL' If none of those vars are specified and
      the '--as' option is not passed, the command will fail.
    arguments: "<incident-id>"
    rules:
      - must have pagerduty:write
    options:
      as:
        type: string
        required: false
        short_flag: a
        description: The email of a PagerDuty user
  resolve:
    executable: /home/bundle/cog-command
    description: Resolve incidents
    long_description: |
      Returns confirmation of resolution

      Requires the following environment variables:

        PAGERDUTY_ACCOUNT_SUBDOMAIN
        PAGERDUTY_ACCOUNT_TOKEN

      Behavior is configured by the following environment variables:

        PAGERDUTY_DEFAULT_EMAIL
          The default pagerduty email to acknowledge incidents as

        PAGERDUTY_EMAIL_FOR_<COG_USER>
          Used to map cog users to pagerduty emails

      An email mapping to a pagerduty account is required in order to
      resolve incidents. If the '--as' option has been specified then
      that email will be used. If not this command will first look for
      an environment variable in the form of
      'PAGERDUTY_EMAIL_FOR_<COG_USER>', so if your user name is 'bob'
      the env var will be 'PAGERDUTY_EMAIL_FOR_BOB', and use that email
      to acknowledge the incident. If that fails it will try
      'PAGERDUTY_DEFAULT_EMAIL' If none of those vars are specified and
      the '--as' option is not passed, the command will fail.
    arguments: "<incident-id>"
    rules:
      - must have pagerduty:write
    options:
      as:
        type: string
        required: false
        short_flag: a
        description: The email of a PagerDuty user
  incidents:
    executable: /home/bundle/cog-command
    description: List incidents
    long_description: |
      Retrieves incidents matching the specified option. By default,
      only returns triggered incidents.

      Requires the following environment variables:

        PAGERDUTY_ACCOUNT_SUBDOMAIN
        PAGERDUTY_ACCOUNT_TOKEN
    rules:
      - must have pagerduty:read
    options:
      triggered:
        type: bool
        required: false
        short_flag: t
      acked:
        type: bool
        required: false
        short_flag: a
      resolved:
        type: bool
        required: false
        short_flag: r
      limit:
        type: int
        required: false
        short_flag: l
templates:
  oncall:
    body: |
      ~each var=$results~
      | ~$item.name~ |
      | --- |
      ~each var=$item.oncall~
      | ~$item.name~ <<~$item.email~>> |
      ~end~
      ~br~
      ~end~
  incidents:
    body: |
      | Service | Status | Subject | URL |
      | ------- | ------ | ------- | --- |
      ~each var=$results~
      | ~$item.service.name~ | ~$item.status~ | ~$item.summary.subject~ | ~$item.url~ |
      ~end~