community.general.bigpanda – Notify BigPanda about deployments

Note

This plugin is part of the community.general collection.

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

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

Synopsis

  • Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.

Parameters

Parameter Choices/Defaults Comments
component
string / required
The name of the component being deployed. Ex: billing

aliases: name
deployment_message
string
added in 0.2.0 of community.general
Message about the deployment.
message alias is deprecated in community.general 0.2.0, since it is used internally by Ansible Core Engine.

aliases: message
description
string
Free text description of the deployment.
env
string
The environment name, typically 'production', 'staging', etc.
hosts
string
Default:
"machine\u0027s hostname"
Name of affected host name. Can be a list.

aliases: host
owner
string
The person responsible for the deployment.
state
string / required
    Choices:
  • started
  • finished
  • failed
State of the deployment.
token
string / required
API token.
url
string
Default:
"https://api.bigpanda.io"
Base URL of the API server.
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 / required
The deployment version.

Examples

- name: Notify BigPanda about a deployment
  community.general.bigpanda:
    component: myapp
    version: '1.3'
    token: '{{ bigpanda_token }}'
    state: started

- name: Notify BigPanda about a deployment
  community.general.bigpanda:
    component: myapp
    version: '1.3'
    token: '{{ bigpanda_token }}'
    state: finished

# If outside servers aren't reachable from your machine, use delegate_to and override hosts:
- name: Notify BigPanda about a deployment
  community.general.bigpanda:
    component: myapp
    version: '1.3'
    token: '{{ bigpanda_token }}'
    hosts: '{{ ansible_hostname }}'
    state: started
  delegate_to: localhost
  register: deployment

- name: Notify BigPanda about a deployment
  community.general.bigpanda:
    component: '{{ deployment.component }}'
    version: '{{ deployment.version }}'
    token: '{{ deployment.token }}'
    state: finished
  delegate_to: localhost

Authors

  • Hagai Kariti (@hkariti)