You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.newrelic_deployment – Notify newrelic about app deployments

Note

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

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

• Notify newrelic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)

Parameters

Parameter	Comments
app_name string	(one of app_name or application_id are required) The value of app_name in the newrelic.yml file used by the application
application_id string	(one of app_name or application_id are required) The application id, found in the URL when viewing the application in RPM
appname string	Name of the application
changelog string	A list of changes for this deployment
description string	Text annotation for the deployment - notes for you
environment string	The environment for this deployment
revision string	A revision number (e.g., git commit SHA)
token string / required	API token, to place in the x-api-key header.
user string	The name of the user/process that triggered this deployment
validate_certs boolean	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: no yes ← (default)

Examples

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

Authors

• Matt Coddington (@mcodd)