/ home / community / community.general / 0.2.1 / module / stackdriver

community.general.stackdriver (0.2.1) — module

Send code deploy and annotation events to stackdriver

Authors: Ben Whaley (@bwhaley)

Install collection

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

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.2.1

Description

Send code deploy and annotation events to Stackdriver

Usage examples

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Inputs

    
key:
    description:
    - API key.
    required: true

msg:
    description:
    - "The contents of the annotation message, in plain text. \_Limited to 256 characters.\
      \ Required for annotation."

event:
    choices:
    - annotation
    - deploy
    description:
    - The type of event to send, either annotation or deploy

level:
    choices:
    - INFO
    - WARN
    - ERROR
    default: INFO
    description:
    - "one of INFO/WARN/ERROR, defaults to INFO if not supplied. \_May affect display."

repository:
    description:
    - The repository (or project) deployed

deployed_by:
    default: Ansible
    description:
    - The person or robot responsible for deploying the code

deployed_to:
    description:
    - 'The environment code was deployed to. (ie: development, staging, production)'

event_epoch:
    description:
    - Unix timestamp of where the event should appear in the timeline, defaults to now.
      Be careful with this.

instance_id:
    description:
    - id of an EC2 instance that this event should be attached to, which will limit the
      contexts where this event is shown

revision_id:
    description:
    - The revision of the code that was deployed. Required for deploy events

annotated_by:
    default: Ansible
    description:
    - "The person or robot\_who the annotation should be attributed to."