Docs4dev
Docs
ansible / 2.4 / stackdriver_module.html

stackdriver - Send code deploy and annotation events to stackdriver

New in version 1.6.

Synopsis

  • Send code deploy and annotation events to Stackdriver

Options

parameter required default choices comments
annotated_by
 no Ansible
The person or robot who the annotation should be attributed to.
deployed_by
 no Ansible
The person or robot responsible for deploying the code
deployed_to
 no
The environment code was deployed to. (ie: development, staging, production)
event
 no
  • annotation
  • deploy
The type of event to send, either annotation or deploy
event_epoch
 no
Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this.
instance_id
 no
id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown
key
 yes
API key.
level
 no INFO
  • INFO
  • WARN
  • ERROR
one of INFO/WARN/ERROR, defaults to INFO if not supplied. May affect display.
msg
 no
The contents of the annotation message, in plain text. Limited to 256 characters. Required for annotation.
repository
 no
The repository (or project) deployed
revision_id
 no
The revision of the code that was deployed. Required for deploy events

Examples

- stackdriver:
    key: AAAAAA
    event: deploy
    deployed_to: production
    deployed_by: leeroyjenkins
    repository: MyWebApp
    revision_id: abcd123

- stackdriver:
    key: AAAAAA
    event: annotation
    msg: Greetings from Ansible
    annotated_by: leeroyjenkins
    level: WARN
    instance_id: i-abcd1234

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/stackdriver_module.html