Docs4dev
Docs
ansible / latest / collections / community / general / airbrake_deployment_module.html

community.general.airbrake_deployment – Notify airbrake about app deployments

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

Parameters

Parameter Choices/Defaults Comments
environment
string / required
The airbrake environment name, typically 'production', 'staging', etc.
project_id
string / required
added in 0.2.0 of community.general
Airbrake PROJECT_ID
project_key
string / required
added in 0.2.0 of community.general
Airbrake PROJECT_KEY.
repo
string
URL of the project repository
revision
string
A hash, number, tag, or other identifier showing what revision from version control was deployed
url
string
Default:
"https://api.airbrake.io/api/v4/projects/"
Optional URL to submit the notification to. Use to send notifications to Airbrake-compliant tools like Errbit.
user
string
The username of the person doing the 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.
version
string
added in 1.0.0 of community.general
A string identifying what version was deployed

Examples

- name: Notify airbrake about an app deployment
  community.general.airbrake_deployment:
    project_id: '12345'
    project_key: 'AAAAAA'
    environment: staging
    user: ansible
    revision: '4.2'

- name: Notify airbrake about an app deployment, using git hash as revision
  community.general.airbrake_deployment:
    project_id: '12345'
    project_key: 'AAAAAA'
    environment: staging
    user: ansible
    revision: 'e54dd3a01f2c421b558ef33b5f79db936e2dcf15'
    version: '0.2.0'

Authors

  • Bruce Pennypacker (@bpennypacker)
  • Patrick Humpal (@phumpal)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/airbrake_deployment_module.html