community.general.airbrake_deployment module – Notify airbrake about app deployments

Note

This module is part of the community.general collection (version 10.0.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

Comments

environment

string / required

The airbrake environment name, typically ‘production’, ‘staging’, etc.

project_id

string / required

added in community.general 0.2.0

Airbrake PROJECT_ID

project_key

string / required

added in community.general 0.2.0

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

Optional URL to submit the notification to. Use to send notifications to Airbrake-compliant tools like Errbit.

Default: "https://api.airbrake.io/api/v4/projects/"

user

string

The username of the person doing the deployment

validate_certs

boolean

If false, SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

version

string

added in community.general 1.0.0

A string identifying what version was deployed

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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)