community.general.newrelic_deployment module – Notify New Relic about app deployments

Note

This module is part of the community.general collection (version 10.0.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.newrelic_deployment.

Synopsis

Parameters

Parameter

Comments

app_name

string

The value of app_name in the newrelic.yml file used by the application.

One of app_name or application_id is required.

app_name_exact_match

boolean

added in community.general 7.5.0

If this flag is set to true then the application ID lookup by name would only work for an exact match. If set to false it returns the first result.

Choices:

  • false ← (default)

  • true

application_id

string

The application ID found in the metadata of the application in APM.

One of app_name or application_id is required.

changelog

string

A list of changes for this deployment

description

string

Text annotation for the deployment - notes for you

revision

string / required

A revision number (e.g., git commit SHA)

token

string / required

API token to place in the Api-Key header.

user

string

The name of the user/process that triggered this deployment

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name:  Notify New Relic about an app deployment
  community.general.newrelic_deployment:
    token: AAAAAA
    app_name: myapp
    user: ansible deployment
    revision: '1.0'

Authors

  • Matt Coddington (@mcodd)