bigpanda - Notify BigPanda about deployments
New in version 1.8.
Synopsis
- Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| component | yes | The name of the component being deployed. Ex: billing aliases: name | ||
| description | no | Free text description of the deployment. | ||
| env | no | The environment name, typically 'production', 'staging', etc. | ||
| hosts | no | machine's hostname | Name of affected host name. Can be a list. aliases: host | |
| owner | no | The person responsible for the deployment. | ||
| state | yes |
| State of the deployment. | |
| token | yes | API token. | ||
| url | no | https://api.bigpanda.io | Base URL of the API server. | |
| validate_certs | 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 | yes | The deployment version. |
Examples
- bigpanda:
component: myapp
version: '1.3'
token: '{{ bigpanda_token }}'
state: started
- 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:
- bigpanda:
component: myapp
version: '1.3'
token: '{{ bigpanda_token }}'
hosts: '{{ ansible_hostname }}'
state: started
delegate_to: localhost
register: deployment
- bigpanda:
component: '{{ deployment.component }}'
version: '{{ deployment.version }}'
token: '{{ deployment.token }}'
state: finished
delegate_to: localhost
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigpanda_module.html