community.general.newrelic_deployment (8.5.0) — module

Notify New Relic about app deployments

Authors: Matt Coddington (@mcodd)

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 New Relic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-monitor-deployments/)

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name:  Notify New Relic about an app deployment
  community.general.newrelic_deployment:
    token: AAAAAA
    app_name: myapp
    user: ansible deployment
    revision: '1.0'

Inputs

    
user:
    description:
    - The name of the user/process that triggered this deployment
    required: false
    type: str

token:
    description:
    - API token to place in the Api-Key header.
    required: true
    type: str

app_name:
    description:
    - The value of C(app_name) in the C(newrelic.yml) file used by the application.
    - One of O(app_name) or O(application_id) is required.
    required: false
    type: str

revision:
    description:
    - A revision number (e.g., git commit SHA)
    required: true
    type: str

changelog:
    description:
    - A list of changes for this deployment
    required: false
    type: str

description:
    description:
    - Text annotation for the deployment - notes for you
    required: false
    type: str

application_id:
    description:
    - The application ID found in the metadata of the application in APM.
    - One of O(app_name) or O(application_id) is required.
    required: false
    type: str

validate_certs:
    default: true
    description:
    - If V(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

app_name_exact_match:
    default: false
    description:
    - If this flag is set to V(true) then the application ID lookup by name would only
      work for an exact match. If set to V(false) it returns the first result.
    required: false
    type: bool
    version_added: 7.5.0
    version_added_collection: community.general