community.general.bigpanda (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• 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:
- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Notify BigPanda about a deployment
  community.general.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
    type: str

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

hosts:
    aliases:
    - host
    description:
    - Name of affected host name. Can be a list.
    - If not specified, it defaults to the remote system's hostname.
    required: false
    type: str

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

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

token:
    description:
    - API token.
    required: true
    type: str

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

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

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

source_system:
    default: ansible
    description:
    - Source system used in the requests to the API
    type: str

validate_certs:
    default: true
    description:
    - If V(false), 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

deployment_message:
    description:
    - Message about the deployment.
    type: str
    version_added: 0.2.0
    version_added_collection: community.general