W3cubDocs

/Ansible

community.general.stackdriver – Send code deploy and annotation events to stackdriver

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.stackdriver.

Synopsis

  • Send code deploy and annotation events to Stackdriver

Parameters

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

Examples

- name: Send a code deploy event to stackdriver
  community.general.stackdriver:
    key: AAAAAA
    event: deploy
    deployed_to: production
    deployed_by: leeroyjenkins
    repository: MyWebApp
    revision_id: abcd123

- name: Send an annotation event to stackdriver
  community.general.stackdriver:
    key: AAAAAA
    event: annotation
    msg: Greetings from Ansible
    annotated_by: leeroyjenkins
    level: WARN
    instance_id: i-abcd1234

Authors

  • Ben Whaley (@bwhaley)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/stackdriver_module.html