community.general.pagerduty_change – Track a code or infrastructure change as a PagerDuty change event

Note

This plugin is part of the community.general collection (version 2.2.0).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.pagerduty_change.

New in version 1.3.0: of community.general

Synopsis

  • This module will let you create a PagerDuty change event each time the module is run.

  • This is not an idempotent action and a new change event will be created each time it is run.

Requirements

The below requirements are needed on the host that executes this module.

  • PagerDuty integration key

Parameters

Parameter Choices/Defaults Comments
environment
string
The environment name, typically production, staging, etc.
integration_key
string / required
The integration key that identifies the service the change was made to. This can be found by adding an integration to a service in PagerDuty.
link_text
string
Descriptive text for a URL where more information about the deployment can be obtained.
link_url
string
A URL where more information about the deployment can be obtained.
repo
string
The URL of the project repository.
revision
string
An identifier of the revision being deployed, typically a number or SHA from a version control system.
source
string
Default:
"Ansible"
The source of the change event.
summary
string / required
A short description of the change that occurred.
url
string
Default:
"https://events.pagerduty.com/v2/change/enqueue"
URL to submit the change event to.
user
string
The name of the user or process that triggered this deployment.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates for the target URL will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Notes

Note

  • Supports check_mode. Note that check mode simply does nothing except returning changed=true in case the url seems to be correct.

Examples

- name: Track the deployment as a PagerDuty change event
  community.general.pagerduty_change:
    integration_key: abc123abc123abc123abc123abc123ab
    summary: The application was deployed

- name: Track the deployment as a PagerDuty change event with more details
  community.general.pagerduty_change:
    integration_key: abc123abc123abc123abc123abc123ab
    summary: The application was deployed
    source: Ansible Deploy
    user: ansible
    repo: github.com/ansible/ansible
    revision: '4.2'
    environment: production
    link_url: https://github.com/ansible-collections/community.general/pull/1269
    link_text: View changes on GitHub

Authors

  • Adam Vaughan (@adamvaughan)