Documentation

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
    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.
          owner
          		 no
            The person responsible for the deployment.
            state
            		 yes
            • started
            • finished
            • failed
            State of the deployment.
            token
            		 yes
              API token.
              url
              		 no https://api.bigpanda.io
                Base URL of the API server.
                validate_certs
                		 no yes
                • yes
                • no
                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

or using a deployment object:
- bigpanda: component=myapp version=1.3 token={{ bigpanda_token }} state=started
  register: deployment

- bigpanda: state=finished
  args: deployment

If outside servers aren't reachable from your machine, use local_action and pass the hostname:
- local_action: bigpanda component=myapp version=1.3 hosts={{ansible_hostname}} token={{ bigpanda_token }} state=started
  register: deployment
...
- local_action: bigpanda state=finished
  args: deployment

                  This is an Extras Module

                  For more information on what this means please read Extras Modules

                  For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.