ansible-collection/grafana-ansible-collection
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Docs

Browse Source
This commit is contained in:
Ishan Jain 2022-08-30 12:16:55 +05:30
parent daf3b49093
commit f5b48cc0bc
13 changed files with 77 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.rst
View File

@ -4,13 +4,22 @@ Grafana.Grafana Release Notes
.. contents:: Topics .. contents:: Topics
v1.0.2
======
Minor Changes
-------------
- Documentation updates with updated description for modules.
v1.0.1 v1.0.1
====== ======
Minor Changes Minor Changes
------------- -------------
- Documentation updates - Documentation updates with updated examples.
v1.0.0 v1.0.0
@ -87,4 +96,4 @@ New Modules
- cloud_stack - Manage Grafana Cloud Plugins. - cloud_stack - Manage Grafana Cloud Plugins.
- dashboard - Manage Dashboards in Grafana - dashboard - Manage Dashboards in Grafana
- datasource - Manage Data sources in Grafana - datasource - Manage Data sources in Grafana
- folder - Manage Folders in Grafana - folder - Manage Folders in Grafana

6
README.md
View File

@ -1,9 +1,9 @@
# Ansible Collection - grafana.grafana # Ansible Collection for Grafana Cloud
[![CI Tests](https://github.com/grafana/grafana-ansible-collection/actions/workflows/ci-test.yml/badge.svg)](https://github.com/grafana/grafana-ansible-collection/actions/workflows/ci-test.yml) [![CI Tests](https://github.com/grafana/grafana-ansible-collection/actions/workflows/ci-test.yml/badge.svg)](https://github.com/grafana/grafana-ansible-collection/actions/workflows/ci-test.yml)
[![Full Integration Test](https://github.com/grafana/grafana-ansible-collection/actions/workflows/full-integration-test.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-ansible-collection/actions/workflows/full-integration-test.yml) [![Full Integration Test](https://github.com/grafana/grafana-ansible-collection/actions/workflows/full-integration-test.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-ansible-collection/actions/workflows/full-integration-test.yml)
This collection contains modules and plugins to assist in automating managing of resources in Grafana with Ansible. This collection (grafana.grafana) contains modules and plugins to assist in automating managing of resources in <b>Grafana Cloud</b> with Ansible.
- [Ansible collection Documentation](https://grafana.github.io/grafana-ansible-collection/) - [Ansible collection Documentation](https://grafana.github.io/grafana-ansible-collection/)
- [Grafana website](https://grafana.com) - [Grafana website](https://grafana.com)
@ -112,4 +112,4 @@ This collection follows the Ansible project's [Code of Conduct](https://docs.ans
## License ## License
GPL-3.0-or-later GPL-3.0-or-later

12
changelogs/.plugin-cache.yaml
View File

@ -11,12 +11,12 @@ plugins:
lookup: {} lookup: {}
module: module:
alert_contact_point: alert_contact_point:
description: Manage Alerting Contact points in Grafana description: Manage Alerting Contact points in Grafana Cloud
name: alert_contact_point name: alert_contact_point
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
alert_notification_policy: alert_notification_policy:
description: Sets the notification policy tree in Grafana Alerting description: Sets the notification policy tree in Alerting on Grafana Cloud
name: alert_notification_policy name: alert_notification_policy
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
@ -36,17 +36,17 @@ plugins:
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
dashboard: dashboard:
description: Manage Dashboards in Grafana description: Manage Dashboards in Grafana Cloud
name: dashboard name: dashboard
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
datasource: datasource:
description: Manage Data sources in Grafana description: Manage Data sources in Grafana Cloud
name: datasource name: datasource
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
folder: folder:
description: Manage Folders in Grafana description: Manage Folders in Grafana Cloud
name: folder name: folder
namespace: '' namespace: ''
version_added: 0.0.1 version_added: 0.0.1
@ -54,4 +54,4 @@ plugins:
shell: {} shell: {}
strategy: {} strategy: {}
vars: {} vars: {}
version: 1.0.1 version: 1.0.2

2
changelogs/changelog.yaml
View File

@ -6,3 +6,5 @@ releases:
release_date: '2022-08-16' release_date: '2022-08-16'
1.0.1: 1.0.1:
release_date: '2022-08-23' release_date: '2022-08-23'
1.0.2:
release_date: '2022-08-30'

2
galaxy.yml
View File

@ -1,6 +1,6 @@
namespace: grafana namespace: grafana
name: grafana name: grafana
version: 1.0.1 version: 1.0.2
readme: README.md readme: README.md
authors: authors:
- Grafana Labs <grafana.com> - Grafana Labs <grafana.com>

20
plugins/modules/alert_contact_point.py
View File

@ -12,14 +12,14 @@ module: alert_contact_point
author: author:
- Ishan Jain (@ishanjainn) - Ishan Jain (@ishanjainn)
version_added: "0.0.1" version_added: "0.0.1"
short_description: Manage Alerting Contact points in Grafana short_description: Manage Alerting Contact points in Grafana Cloud
description: description:
- Create, Update and delete Contact points using Ansible. - Create, Update and delete Contact points using Ansible.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
name: name:
description: description:
- Name of the contact point - Sets the name of the contact point.
type: str type: str
required: true required: true
uid: uid:
@ -29,17 +29,17 @@ options:
required: true required: true
type: type:
description: description:
- Contact point type - Sets Contact point type.
type: str type: str
required: true required: true
settings: settings:
description: description:
- Contact point settings - Sets Contact point settings.
type: dict type: dict
required: true required: true
DisableResolveMessage: disableResolveMessage:
description: description:
- When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false - When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false.
type: bool type: bool
default: false default: false
grafana_api_key: grafana_api_key:
@ -49,12 +49,12 @@ options:
required : true required : true
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the contact points will be added - Name of the Grafana Cloud stack to which the contact points will be added.
type: str type: str
required: true required: true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
choices: [ present, absent ] choices: [ present, absent ]
type: str type: str
default: present default: present
@ -130,7 +130,7 @@ def present_alert_contact_point(module):
'UID': module.params['uid'], 'UID': module.params['uid'],
'type': module.params['type'], 'type': module.params['type'],
'settings': module.params['settings'], 'settings': module.params['settings'],
'DisableResolveMessage': module.params['DisableResolveMessage'] 'DisableResolveMessage': module.params['disableResolveMessage']
} }
api_url = 'https://' + module.params['stack_slug'] + '.grafana.net/api/v1/provisioning/contact-points' api_url = 'https://' + module.params['stack_slug'] + '.grafana.net/api/v1/provisioning/contact-points'
@ -188,7 +188,7 @@ def main():
uid=dict(type='str', required=True), uid=dict(type='str', required=True),
type=dict(type='str', required=True), type=dict(type='str', required=True),
settings=dict(type='dict', required=True), settings=dict(type='dict', required=True),
DisableResolveMessage=dict(type='bool', required=False, default=False), disableResolveMessage=dict(type='bool', required=False, default=False),
stack_slug=dict(type='str', required=True), stack_slug=dict(type='str', required=True),
grafana_api_key=dict(type='str', required=True, no_log=True), grafana_api_key=dict(type='str', required=True, no_log=True),
state=dict(type='str', required=False, default='present', choices=['present', 'absent']) state=dict(type='str', required=False, default='present', choices=['present', 'absent'])

24
plugins/modules/alert_notification_policy.py
View File

@ -12,9 +12,9 @@ module: alert_notification_policy
author: author:
- Ishan Jain (@ishanjainn) - Ishan Jain (@ishanjainn)
version_added: "0.0.1" version_added: "0.0.1"
short_description: Sets the notification policy tree in Grafana Alerting short_description: Sets the notification policy tree in Alerting on Grafana Cloud
description: description:
- Set the notification policy tree using Ansible - Set the notification policy tree using Ansible.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
Continue: Continue:
@ -32,30 +32,30 @@ options:
muteTimeIntervals: muteTimeIntervals:
description: description:
- List of string. - List of string.
- Add mute timing to policy - Sets the mute timing for the notfification policy.
type: list type: list
default: [] default: []
elements: str elements: str
root_policy_receiver: rootPolicyReceiver:
description: description:
- Name of the contact point to set as the default receiver - Sets the name of the contact point to be set as the default receiver.
type: str type: str
default: grafana-default-email default: grafana-default-email
routes: routes:
description: description:
- List of objects - List of objects
- A Route is a node that contains definitions of how to handle alerts. - Sets the Route that contains definitions of how to handle alerts.
type: list type: list
required: true required: true
elements: dict elements: dict
groupInterval: groupInterval:
description: description:
- The wait time to send a batch of new alerts for that group after the first notification was sent. Inherited from the parent policy if empty. - Sets the wait time to send a batch of new alerts for that group after the first notification was sent. Inherited from the parent policy if empty.
type: str type: str
default: 5m default: 5m
groupWait: groupWait:
description: description:
- The wait time until the initial notification is sent for a new group created by an incoming alert. Inherited from the parent policy if empty. - Sets the wait time until the initial notification is sent for a new group created by an incoming alert. Inherited from the parent policy if empty.
type: str type: str
default: 30s default: 30s
objectMatchers: objectMatchers:
@ -66,12 +66,12 @@ options:
elements: dict elements: dict
repeatInterval: repeatInterval:
description: description:
- The waiting time to resend an alert after they have successfully been sent. - Sets the waiting time to resend an alert after they have successfully been sent.
type: str type: str
default: 4h default: 4h
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the notification policies will be added - Name of the Grafana Cloud stack to which the notification policies will be added.
type: str type: str
required: true required: true
grafana_api_key: grafana_api_key:
@ -156,7 +156,7 @@ __metaclass__ = type
def alert_notification_policy(module): def alert_notification_policy(module):
body = {'routes': module.params['routes'], 'Continue': module.params['Continue'], body = {'routes': module.params['routes'], 'Continue': module.params['Continue'],
'groupByStr': module.params['groupByStr'], 'muteTimeIntervals': module.params['muteTimeIntervals'], 'groupByStr': module.params['groupByStr'], 'muteTimeIntervals': module.params['muteTimeIntervals'],
'receiver': module.params['root_policy_receiver'], 'group_interval': module.params['groupInterval'], 'receiver': module.params['rootPolicyReceiver'], 'group_interval': module.params['groupInterval'],
'group_wait': module.params['groupWait'], 'object_matchers': module.params['objectMatchers'], 'group_wait': module.params['groupWait'], 'object_matchers': module.params['objectMatchers'],
'repeat_interval': module.params['repeatInterval']} 'repeat_interval': module.params['repeatInterval']}
@ -177,7 +177,7 @@ def main():
module_args = dict(Continue=dict(type='bool', required=False, default=False), module_args = dict(Continue=dict(type='bool', required=False, default=False),
groupByStr=dict(type='list', required=False, default=[], elements='str'), groupByStr=dict(type='list', required=False, default=[], elements='str'),
muteTimeIntervals=dict(type='list', required=False, default=[], elements='str'), muteTimeIntervals=dict(type='list', required=False, default=[], elements='str'),
root_policy_receiver=dict(type='str', required=False, default='grafana-default-email'), rootPolicyReceiver=dict(type='str', required=False, default='grafana-default-email'),
routes=dict(type='list', required=True, elements='dict'), routes=dict(type='list', required=True, elements='dict'),
groupInterval=dict(type='str', required=False, default='5m'), groupInterval=dict(type='str', required=False, default='5m'),
groupWait=dict(type='str', required=False, default='30s'), groupWait=dict(type='str', required=False, default='30s'),

12
plugins/modules/cloud_api_key.py
View File

@ -19,33 +19,33 @@ requirements: [ "requests >= 1.0.0" ]
options: options:
name: name:
description: description:
- Name of the Grafana Cloud API key. - Sets the name of the Grafana Cloud API key.
type: str type: str
required: true required: true
role: role:
description: description:
- Role to be associated with the CLoud API key. - Sets the role to be associated with the CLoud API key.
type: str type: str
required: true required: true
choices: [Admin, Viewer, Editor, MetricsPublisher] choices: [Admin, Viewer, Editor, MetricsPublisher]
org_slug: org_slug:
description: description:
- Name of the Grafana Cloud organization in which Cloud API key will be created - Name of the Grafana Cloud organization in which Cloud API key will be created.
type: str type: str
required: true required: true
existing_cloud_api_key: existing_cloud_api_key:
description: description:
- CLoud API Key to authenticate with Grafana Cloud. - Cloud API Key to authenticate with Grafana Cloud.
type: str type: str
required : true required : true
fail_if_already_created: fail_if_already_created:
description: description:
- If set to True, the task will fail if the API key with same name already exists in the Organization. - If set to `True`, the task will fail if the API key with same name already exists in the Organization.
type: bool type: bool
default: True default: True
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
type: str type: str
default: present default: present
choices: [ present, absent ] choices: [ present, absent ]

10
plugins/modules/cloud_plugin.py
View File

@ -19,27 +19,27 @@ requirements: [ "requests >= 1.0.0" ]
options: options:
name: name:
description: description:
- Name of the plugin, e.g. grafana-github-datasource . - Name of the plugin, e.g. grafana-github-datasource.
type: str type: str
required: true required: true
version: version:
description: description:
- Version of the plugin to install. Defaults to latest. - Version of the plugin to install.
type: str type: str
default: latest default: latest
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the plugin will be added - Name of the Grafana Cloud stack to which the plugin will be added.
type: str type: str
required: true required: true
cloud_api_key: cloud_api_key:
description: description:
- CLoud API Key to authenticate with Grafana Cloud. - Cloud API Key to authenticate with Grafana Cloud.
type: str type: str
required : true required : true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
type: str type: str
default: present default: present
choices: [ present, absent ] choices: [ present, absent ]

12
plugins/modules/cloud_stack.py
View File

@ -19,28 +19,28 @@ requirements: [ "requests >= 1.0.0" ]
options: options:
name: name:
description: description:
- Name of stack. Conventionally matches the URL of the instance. For example, "<stack_slug>.grafana.net". - Sets the name of stack. Conventionally matches the URL of the instance. For example, "<stack_slug>.grafana.net".
type: str type: str
required: true required: true
stack_slug: stack_slug:
description: description:
- Subdomain of the Grafana instance. For example, if slug is <stack_slug>, the instance URL will be https://<stack_slug>.grafana.net - Sets the subdomain of the Grafana instance. For example, if slug is <stack_slug>, the instance URL will be `https://<stack_slug>.grafana.net`.
type: str type: str
required: true required: true
cloud_api_key: cloud_api_key:
description: description:
- CLoud API Key to authenticate with Grafana Cloud. - Cloud API Key to authenticate with Grafana Cloud.
type: str type: str
required : true required : true
region: region:
description: description:
- Choose a region for your stack. - Sets the region for the Grafana Cloud stack.
type: str type: str
default: us default: us
choices: [ us, us-azure, eu, au, eu-azure, prod-ap-southeast-0, prod-gb-south-0, prod-eu-west-3] choices: [ us, us-azure, eu, au, eu-azure, prod-ap-southeast-0, prod-gb-south-0, prod-eu-west-3]
url: url:
description: description:
- If you use a custom domain for the instance, you can provide it here. Will be set to https://<stack_slug>.grafana.net if not provided. - If you use a custom domain for the instance, you can provide it here. If not provided, Will be set to `https://<stack_slug>.grafana.net`.
type: str type: str
org_slug: org_slug:
description: description:
@ -49,7 +49,7 @@ options:
required: true required: true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
type: str type: str
default: present default: present
choices: [ present, absent ] choices: [ present, absent ]

10
plugins/modules/dashboard.py
View File

@ -12,29 +12,29 @@ module: dashboard
author: author:
- Ishan Jain (@ishanjainn) - Ishan Jain (@ishanjainn)
version_added: "0.0.1" version_added: "0.0.1"
short_description: Manage Dashboards in Grafana short_description: Manage Dashboards in Grafana Cloud
description: description:
- Create, Update and delete Dashboards using Ansible. - Create, Update and delete Dashboards using Ansible.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
dashboard: dashboard:
description: description:
- JSON source code for dashboard - JSON source code for dashboard.
type: dict type: dict
required: true required: true
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the dashboard will be added - Name of the Grafana Cloud stack to which the dashboard will be added.
type: str type: str
required: true required: true
grafana_api_key: grafana_api_key:
description: description:
- CLoud API Key to authenticate with Grafana Cloud. - Grafana API Key to authenticate with Grafana Cloud.
type: str type: str
required : true required : true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
choices: [ present, absent ] choices: [ present, absent ]
default: present default: present
type: str type: str

10
plugins/modules/datasource.py
View File

@ -12,29 +12,29 @@ module: datasource
author: author:
- Ishan Jain (@ishanjainn) - Ishan Jain (@ishanjainn)
version_added: "0.0.1" version_added: "0.0.1"
short_description: Manage Data sources in Grafana short_description: Manage Data sources in Grafana Cloud
description: description:
- Create, Update and delete Data sources using Ansible. - Create, Update and delete Data sources using Ansible.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
datasource: datasource:
description: description:
- JSON source code for the Data source - JSON source code for the Data source.
type: dict type: dict
required: true required: true
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the data source will be added - Name of the Grafana Cloud stack to which the data source will be added.
type: str type: str
required: true required: true
grafana_api_key: grafana_api_key:
description: description:
- CLoud API Key to authenticate with Grafana Cloud. - Grafana API Key to authenticate with Grafana Cloud.
type: str type: str
required : true required : true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
choices: [ present, absent ] choices: [ present, absent ]
default: present default: present
type: str type: str

10
plugins/modules/folder.py
View File

@ -12,19 +12,19 @@ module: folder
author: author:
- Ishan Jain (@ishanjainn) - Ishan Jain (@ishanjainn)
version_added: "0.0.1" version_added: "0.0.1"
short_description: Manage Folders in Grafana short_description: Manage Folders in Grafana Cloud
description: description:
- Create, Update and delete Folders via Ansible. - Create, Update and delete Folders via Ansible.
requirements: [ "requests >= 1.0.0" ] requirements: [ "requests >= 1.0.0" ]
options: options:
title: title:
description: description:
- The title of the folder. - Sets the title of the folder.
type: str type: str
required: true required: true
uid: uid:
description: description:
- unique identifier for your folder. - Sets the UID for your folder.
type: str type: str
required: true required: true
overwrite: overwrite:
@ -40,12 +40,12 @@ options:
required : true required : true
stack_slug: stack_slug:
description: description:
- Name of the Grafana Cloud stack to which the folder will be added - Name of the Grafana Cloud stack to which the folder will be added.
type: str type: str
required: true required: true
state: state:
description: description:
- State for the Grafana CLoud stack. - State for the Grafana Cloud stack.
choices: [ present, absent ] choices: [ present, absent ]
default: present default: present
type: str type: str