mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-19 11:20:22 -07:00
Unflatmap community.general (#5461)
* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
This commit is contained in:
Felix Fontein
GitHub
parent
2b0bebc8fc
commit
b531ecdc9b
1033 changed files with 4802 additions and 1989 deletions
175
plugins/modules/newrelic_deployment.py
Normal file
175
plugins/modules/newrelic_deployment.py
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2013 Matt Coddington <coddington@gmail.com>
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: newrelic_deployment
|
||||
author: "Matt Coddington (@mcodd)"
|
||||
short_description: Notify New Relic about app deployments
|
||||
description:
|
||||
- Notify New Relic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-monitor-deployments/)
|
||||
options:
|
||||
token:
|
||||
type: str
|
||||
description:
|
||||
- API token to place in the Api-Key header.
|
||||
required: true
|
||||
app_name:
|
||||
type: str
|
||||
description:
|
||||
- The value of app_name in the newrelic.yml file used by the application.
|
||||
- One of I(app_name) or I(application_id) is required.
|
||||
required: false
|
||||
application_id:
|
||||
type: str
|
||||
description:
|
||||
- The application ID found in the metadata of the application in APM.
|
||||
- One of I(app_name) or I(application_id) is required.
|
||||
required: false
|
||||
changelog:
|
||||
type: str
|
||||
description:
|
||||
- A list of changes for this deployment
|
||||
required: false
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- Text annotation for the deployment - notes for you
|
||||
required: false
|
||||
revision:
|
||||
type: str
|
||||
description:
|
||||
- A revision number (e.g., git commit SHA)
|
||||
required: true
|
||||
user:
|
||||
type: str
|
||||
description:
|
||||
- The name of the user/process that triggered this deployment
|
||||
required: false
|
||||
appname:
|
||||
type: str
|
||||
description:
|
||||
- Name of the application.
|
||||
- This option has been deprecated and will be removed in community.general 7.0.0. Please do not use.
|
||||
required: false
|
||||
environment:
|
||||
type: str
|
||||
description:
|
||||
- The environment for this deployment.
|
||||
- This option has been deprecated and will be removed community.general 7.0.0. Please do not use.
|
||||
required: false
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(false), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
requirements: []
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Notify New Relic about an app deployment
|
||||
community.general.newrelic_deployment:
|
||||
token: AAAAAA
|
||||
app_name: myapp
|
||||
user: ansible deployment
|
||||
revision: '1.0'
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.urls import fetch_url
|
||||
from ansible.module_utils.six.moves.urllib.parse import quote
|
||||
import json
|
||||
|
||||
# ===========================================
|
||||
# Module execution.
|
||||
#
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
token=dict(required=True, no_log=True),
|
||||
app_name=dict(required=False),
|
||||
application_id=dict(required=False),
|
||||
changelog=dict(required=False),
|
||||
description=dict(required=False),
|
||||
revision=dict(required=True),
|
||||
user=dict(required=False),
|
||||
appname=dict(required=False, removed_in_version='7.0.0', removed_from_collection='community.general'),
|
||||
environment=dict(required=False, removed_in_version='7.0.0', removed_from_collection='community.general'),
|
||||
validate_certs=dict(default=True, type='bool'),
|
||||
),
|
||||
required_one_of=[['app_name', 'application_id']],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
# build list of params
|
||||
params = {}
|
||||
if module.params["app_name"] and module.params["application_id"]:
|
||||
module.fail_json(msg="only one of 'app_name' or 'application_id' can be set")
|
||||
|
||||
app_id = None
|
||||
if module.params["app_name"]:
|
||||
app_id = get_application_id(module)
|
||||
elif module.params["application_id"]:
|
||||
app_id = module.params["application_id"]
|
||||
else:
|
||||
module.fail_json(msg="you must set one of 'app_name' or 'application_id'")
|
||||
|
||||
if app_id is None:
|
||||
module.fail_json(msg="No application with name %s is found in NewRelic" % module.params["app_name"])
|
||||
|
||||
for item in ["changelog", "description", "revision", "user"]:
|
||||
if module.params[item]:
|
||||
params[item] = module.params[item]
|
||||
|
||||
# If we're in check mode, just exit pretending like we succeeded
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=True)
|
||||
|
||||
# Send the data to New Relic
|
||||
url = "https://api.newrelic.com/v2/applications/%s/deployments.json" % quote(str(app_id), safe='')
|
||||
data = {
|
||||
'deployment': params
|
||||
}
|
||||
headers = {
|
||||
'Api-Key': module.params["token"],
|
||||
'Content-Type': 'application/json',
|
||||
}
|
||||
response, info = fetch_url(module, url, data=module.jsonify(data), headers=headers, method="POST")
|
||||
if info['status'] in (200, 201):
|
||||
module.exit_json(changed=True)
|
||||
else:
|
||||
module.fail_json(msg="Unable to insert deployment marker: %s" % info['msg'])
|
||||
|
||||
|
||||
def get_application_id(module):
|
||||
url = "https://api.newrelic.com/v2/applications.json"
|
||||
data = "filter[name]=%s" % module.params["app_name"]
|
||||
headers = {
|
||||
'Api-Key': module.params["token"],
|
||||
}
|
||||
response, info = fetch_url(module, url, data=data, headers=headers)
|
||||
if info['status'] not in (200, 201):
|
||||
module.fail_json(msg="Unable to get application: %s" % info['msg'])
|
||||
|
||||
result = json.loads(response.read())
|
||||
if result is None or len(result.get("applications", "")) == 0:
|
||||
module.fail_json(msg='No application found with name "%s"' % module.params["app_name"])
|
||||
|
||||
return result["applications"][0]["id"]
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue