grafana-ansible-collection/plugins/modules/datasource.py

157 lines
4.8 KiB
Python
Raw Normal View History

2022-08-09 08:37:47 +02:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2021, Rainer Leber <rainerleber@gmail.com> <rainer.leber@sva.de>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
2022-08-09 08:37:47 +02:00
DOCUMENTATION = '''
---
module: datasource
2022-08-09 08:37:47 +02:00
author:
- Ishan Jain (@ishanjainn)
version_added: "0.0.1"
short_description: Manage Data sources in Grafana
description:
- Create, Update and delete Data sources using Ansible.
requirements: [ "requests >= 1.0.0" ]
2022-08-09 08:37:47 +02:00
options:
datasource:
description:
- JSON source code for the Data source
type: dict
required: true
stack_slug:
description:
- Name of the Grafana Cloud stack to which the data source will be added
2022-08-09 08:37:47 +02:00
type: str
required: true
grafana_api_key:
2022-08-09 08:37:47 +02:00
description:
- CLoud API Key to authenticate with Grafana Cloud.
type: str
required : true
state:
description:
- State for the Grafana CLoud stack.
choices: [ present, absent ]
default: present
type: str
'''
EXAMPLES = '''
- name: Create/Update Data sources
2022-08-11 07:09:04 +02:00
grafana.grafana.datasource:
datasource: "{{ lookup('ansible.builtin.file', 'datasource.json') }}"
2022-08-09 08:37:47 +02:00
stack_slug: "{{ stack_slug }}"
grafana_api_key: "{{ grafana_api_key }}"
2022-08-09 08:37:47 +02:00
state: present
- name: Delete Data sources
2022-08-11 07:09:04 +02:00
grafana.grafana.datasource:
datasource: "{{ lookup('ansible.builtin.file', 'datasource.json') }}"
2022-08-09 08:37:47 +02:00
stack_slug: "{{ stack_slug }}"
grafana_api_key: "{{ grafana_api_key }}"
2022-08-09 08:37:47 +02:00
state: absent
'''
RETURN = r'''
2022-08-10 12:43:04 +02:00
output:
2022-08-09 08:37:47 +02:00
description: Dict object containing Data source information
returned: On success
type: dict
contains:
datasource:
description: The response body content for the data source configuration.
returned: state is present and on success
type: dict
id:
description: The ID assigned to the data source
returned: on success
type: int
name:
description: The name of the data source defined in the JSON source code
returned: state is present and on success
type: str
message:
description: The message returned after the operation on the Data source
returned: on success
type: str
'''
from ansible.module_utils.basic import AnsibleModule
try:
import requests
HAS_REQUESTS = True
except ImportError:
HAS_REQUESTS = False
__metaclass__ = type
2022-08-09 08:37:47 +02:00
def present_datasource(module):
api_url = 'https://' + module.params['stack_slug'] + '.grafana.net/api/datasources'
result = requests.post(api_url, json=module.params['datasource'], headers={"Authorization": 'Bearer ' + module.params['grafana_api_key']})
2022-08-09 08:37:47 +02:00
if result.status_code == 200:
return False, True, result.json()
elif result.status_code == 409:
2022-08-10 12:43:04 +02:00
get_id_url = requests.get('https://' + module.params['stack_slug'] + '.grafana.net/api/datasources/id/' + module.params['datasource']['name'],
headers={"Authorization": 'Bearer ' + module.params['grafana_api_key']})
2022-08-09 08:37:47 +02:00
api_url = 'https://' + module.params['stack_slug'] + '.grafana.net/api/datasources/' + str(get_id_url.json()['id'])
result = requests.put(api_url, json=module.params['datasource'], headers={"Authorization": 'Bearer ' + module.params['grafana_api_key']})
2022-08-09 08:37:47 +02:00
if result.status_code == 200:
return False, True, result.json()
else:
return True, False, {"status": result.status_code, 'response': result.json()['message']}
else:
return True, False, {"status": result.status_code, 'response': result.json()['message']}
def absent_datasource(module):
api_url = 'https://' + module.params['stack_slug'] + '.grafana.net/api/datasources/' + module.params['datasource']['name']
result = requests.delete(api_url, headers={"Authorization": 'Bearer ' + module.params['grafana_api_key']})
2022-08-09 08:37:47 +02:00
if result.status_code == 200:
return False, True, result.json()
else:
return True, False, {"status": result.status_code, 'response': result.json()['message']}
def main():
module_args = dict(
datasource=dict(type='dict', required=True),
stack_slug=dict(type='str', required=True),
grafana_api_key=dict(type='str', required=True, no_log=True),
2022-08-09 08:37:47 +02:00
state=dict(type='str', required=False, default='present', choices=['present', 'absent'])
)
choice_map = {
"present": present_datasource,
"absent": absent_datasource,
}
module = AnsibleModule(
argument_spec=module_args,
supports_check_mode=True
)
is_error, has_changed, result = choice_map.get(
module.params['state'])(module)
if not is_error:
module.exit_json(changed=has_changed, output=result)
else:
module.fail_json(msg=result)
if __name__ == '__main__':
main()