community.general.bigpanda module – Notify BigPanda about deployments
Note
This module is part of the community.general collection (version 9.4.0).
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 |
Comments |
---|---|
The name of the component being deployed. Ex: billing |
|
Message about the deployment. |
|
Free text description of the deployment. |
|
The environment name, typically ‘production’, ‘staging’, etc. |
|
Name of affected host name. Can be a list. If not specified, it defaults to the remote system’s hostname. |
|
The person responsible for the deployment. |
|
Source system used in the requests to the API Default: |
|
State of the deployment. Choices:
|
|
API token. |
|
Base URL of the API server. Default: |
|
If Choices:
|
|
The deployment version. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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