W3cubDocs

/Ansible

community.general.bigpanda – Notify BigPanda about 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.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.
description
string
Free text description of the deployment.
env
string
The environment name, typically 'production', 'staging', etc.
hosts
string
Name of affected host name. Can be a list.
If not specified, it defaults to the remote system's hostname.

aliases: host
owner
string
The person responsible for the deployment.
source_system
string
Default:
"ansible"
Source system used in the requests to the API
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)

© 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/bigpanda_module.html