ansible.builtin.bigpanda (v2.9.27) — module

Notify BigPanda about deployments

| "added in version" 1.8 of ansible.builtin"

Authors: Hagai Kariti (@hkariti)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- bigpanda:
    component: myapp
    version: '1.3'
    token: '{{ bigpanda_token }}'
    state: started
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- bigpanda:
    component: myapp
    version: '1.3'
    token: '{{ bigpanda_token }}'
    state: finished
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- bigpanda:
    component: '{{ deployment.component }}'
    version: '{{ deployment.version }}'
    token: '{{ deployment.token }}'
    state: finished
  delegate_to: localhost

Inputs

    
env:
    description:
    - The environment name, typically 'production', 'staging', etc.
    required: false

url:
    default: https://api.bigpanda.io
    description:
    - Base URL of the API server.
    required: false

hosts:
    aliases:
    - host
    default: machine's hostname
    description:
    - Name of affected host name. Can be a list.
    required: false

owner:
    description:
    - The person responsible for the deployment.
    required: false

state:
    choices:
    - started
    - finished
    - failed
    description:
    - State of the deployment.
    required: true

token:
    description:
    - API token.
    required: true

version:
    description:
    - The deployment version.
    required: true

component:
    aliases:
    - name
    description:
    - 'The name of the component being deployed. Ex: billing'
    required: true

description:
    description:
    - Free text description of the deployment.
    required: false

validate_certs:
    default: 'yes'
    description:
    - If C(no), SSL certificates for the target url will not be validated. This should
      only be used on personally controlled sites using self-signed certificates.
    required: false
    type: bool