Updated Docs
This commit is contained in:
parent
daf3b49093
commit
f5b48cc0bc
@ -4,13 +4,22 @@ Grafana.Grafana Release Notes
|
||||
|
||||
.. contents:: Topics
|
||||
|
||||
|
||||
v1.0.2
|
||||
======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Documentation updates with updated description for modules.
|
||||
|
||||
v1.0.1
|
||||
======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Documentation updates
|
||||
- Documentation updates with updated examples.
|
||||
|
||||
|
||||
v1.0.0
|
||||
@ -87,4 +96,4 @@ New Modules
|
||||
- cloud_stack - Manage Grafana Cloud Plugins.
|
||||
- dashboard - Manage Dashboards in Grafana
|
||||
- datasource - Manage Data sources in Grafana
|
||||
- folder - Manage Folders in Grafana
|
||||
- folder - Manage Folders in Grafana
|
||||
|
@ -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)
|
||||
[![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/)
|
||||
- [Grafana website](https://grafana.com)
|
||||
@ -112,4 +112,4 @@ This collection follows the Ansible project's [Code of Conduct](https://docs.ans
|
||||
|
||||
## License
|
||||
|
||||
GPL-3.0-or-later
|
||||
GPL-3.0-or-later
|
@ -11,12 +11,12 @@ plugins:
|
||||
lookup: {}
|
||||
module:
|
||||
alert_contact_point:
|
||||
description: Manage Alerting Contact points in Grafana
|
||||
description: Manage Alerting Contact points in Grafana Cloud
|
||||
name: alert_contact_point
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
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
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
@ -36,17 +36,17 @@ plugins:
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
dashboard:
|
||||
description: Manage Dashboards in Grafana
|
||||
description: Manage Dashboards in Grafana Cloud
|
||||
name: dashboard
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
datasource:
|
||||
description: Manage Data sources in Grafana
|
||||
description: Manage Data sources in Grafana Cloud
|
||||
name: datasource
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
folder:
|
||||
description: Manage Folders in Grafana
|
||||
description: Manage Folders in Grafana Cloud
|
||||
name: folder
|
||||
namespace: ''
|
||||
version_added: 0.0.1
|
||||
@ -54,4 +54,4 @@ plugins:
|
||||
shell: {}
|
||||
strategy: {}
|
||||
vars: {}
|
||||
version: 1.0.1
|
||||
version: 1.0.2
|
||||
|
@ -6,3 +6,5 @@ releases:
|
||||
release_date: '2022-08-16'
|
||||
1.0.1:
|
||||
release_date: '2022-08-23'
|
||||
1.0.2:
|
||||
release_date: '2022-08-30'
|
||||
|
@ -1,6 +1,6 @@
|
||||
namespace: grafana
|
||||
name: grafana
|
||||
version: 1.0.1
|
||||
version: 1.0.2
|
||||
readme: README.md
|
||||
authors:
|
||||
- Grafana Labs <grafana.com>
|
||||
|
@ -12,14 +12,14 @@ module: alert_contact_point
|
||||
author:
|
||||
- Ishan Jain (@ishanjainn)
|
||||
version_added: "0.0.1"
|
||||
short_description: Manage Alerting Contact points in Grafana
|
||||
short_description: Manage Alerting Contact points in Grafana Cloud
|
||||
description:
|
||||
- Create, Update and delete Contact points using Ansible.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the contact point
|
||||
- Sets the name of the contact point.
|
||||
type: str
|
||||
required: true
|
||||
uid:
|
||||
@ -29,17 +29,17 @@ options:
|
||||
required: true
|
||||
type:
|
||||
description:
|
||||
- Contact point type
|
||||
- Sets Contact point type.
|
||||
type: str
|
||||
required: true
|
||||
settings:
|
||||
description:
|
||||
- Contact point settings
|
||||
- Sets Contact point settings.
|
||||
type: dict
|
||||
required: true
|
||||
DisableResolveMessage:
|
||||
disableResolveMessage:
|
||||
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
|
||||
default: false
|
||||
grafana_api_key:
|
||||
@ -49,12 +49,12 @@ options:
|
||||
required : true
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
choices: [ present, absent ]
|
||||
type: str
|
||||
default: present
|
||||
@ -130,7 +130,7 @@ def present_alert_contact_point(module):
|
||||
'UID': module.params['uid'],
|
||||
'type': module.params['type'],
|
||||
'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'
|
||||
|
||||
@ -188,7 +188,7 @@ def main():
|
||||
uid=dict(type='str', required=True),
|
||||
type=dict(type='str', 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),
|
||||
grafana_api_key=dict(type='str', required=True, no_log=True),
|
||||
state=dict(type='str', required=False, default='present', choices=['present', 'absent'])
|
||||
|
@ -12,9 +12,9 @@ module: alert_notification_policy
|
||||
author:
|
||||
- Ishan Jain (@ishanjainn)
|
||||
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:
|
||||
- Set the notification policy tree using Ansible
|
||||
- Set the notification policy tree using Ansible.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
Continue:
|
||||
@ -32,30 +32,30 @@ options:
|
||||
muteTimeIntervals:
|
||||
description:
|
||||
- List of string.
|
||||
- Add mute timing to policy
|
||||
- Sets the mute timing for the notfification policy.
|
||||
type: list
|
||||
default: []
|
||||
elements: str
|
||||
root_policy_receiver:
|
||||
rootPolicyReceiver:
|
||||
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
|
||||
default: grafana-default-email
|
||||
routes:
|
||||
description:
|
||||
- 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
|
||||
required: true
|
||||
elements: dict
|
||||
groupInterval:
|
||||
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
|
||||
default: 5m
|
||||
groupWait:
|
||||
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
|
||||
default: 30s
|
||||
objectMatchers:
|
||||
@ -66,12 +66,12 @@ options:
|
||||
elements: dict
|
||||
repeatInterval:
|
||||
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
|
||||
default: 4h
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
grafana_api_key:
|
||||
@ -156,7 +156,7 @@ __metaclass__ = type
|
||||
def alert_notification_policy(module):
|
||||
body = {'routes': module.params['routes'], 'Continue': module.params['Continue'],
|
||||
'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'],
|
||||
'repeat_interval': module.params['repeatInterval']}
|
||||
|
||||
@ -177,7 +177,7 @@ def main():
|
||||
module_args = dict(Continue=dict(type='bool', required=False, default=False),
|
||||
groupByStr=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'),
|
||||
groupInterval=dict(type='str', required=False, default='5m'),
|
||||
groupWait=dict(type='str', required=False, default='30s'),
|
||||
|
@ -19,33 +19,33 @@ requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the Grafana Cloud API key.
|
||||
- Sets the name of the Grafana Cloud API key.
|
||||
type: str
|
||||
required: true
|
||||
role:
|
||||
description:
|
||||
- Role to be associated with the CLoud API key.
|
||||
- Sets the role to be associated with the CLoud API key.
|
||||
type: str
|
||||
required: true
|
||||
choices: [Admin, Viewer, Editor, MetricsPublisher]
|
||||
org_slug:
|
||||
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
|
||||
required: true
|
||||
existing_cloud_api_key:
|
||||
description:
|
||||
- CLoud API Key to authenticate with Grafana Cloud.
|
||||
- Cloud API Key to authenticate with Grafana Cloud.
|
||||
type: str
|
||||
required : true
|
||||
fail_if_already_created:
|
||||
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
|
||||
default: True
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
|
@ -19,27 +19,27 @@ requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the plugin, e.g. grafana-github-datasource .
|
||||
- Name of the plugin, e.g. grafana-github-datasource.
|
||||
type: str
|
||||
required: true
|
||||
version:
|
||||
description:
|
||||
- Version of the plugin to install. Defaults to latest.
|
||||
- Version of the plugin to install.
|
||||
type: str
|
||||
default: latest
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
cloud_api_key:
|
||||
description:
|
||||
- CLoud API Key to authenticate with Grafana Cloud.
|
||||
- Cloud API Key to authenticate with Grafana Cloud.
|
||||
type: str
|
||||
required : true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
|
@ -19,28 +19,28 @@ requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
name:
|
||||
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
|
||||
required: true
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
cloud_api_key:
|
||||
description:
|
||||
- CLoud API Key to authenticate with Grafana Cloud.
|
||||
- Cloud API Key to authenticate with Grafana Cloud.
|
||||
type: str
|
||||
required : true
|
||||
region:
|
||||
description:
|
||||
- Choose a region for your stack.
|
||||
- Sets the region for the Grafana Cloud stack.
|
||||
type: str
|
||||
default: us
|
||||
choices: [ us, us-azure, eu, au, eu-azure, prod-ap-southeast-0, prod-gb-south-0, prod-eu-west-3]
|
||||
url:
|
||||
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
|
||||
org_slug:
|
||||
description:
|
||||
@ -49,7 +49,7 @@ options:
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
|
@ -12,29 +12,29 @@ module: dashboard
|
||||
author:
|
||||
- Ishan Jain (@ishanjainn)
|
||||
version_added: "0.0.1"
|
||||
short_description: Manage Dashboards in Grafana
|
||||
short_description: Manage Dashboards in Grafana Cloud
|
||||
description:
|
||||
- Create, Update and delete Dashboards using Ansible.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
dashboard:
|
||||
description:
|
||||
- JSON source code for dashboard
|
||||
- JSON source code for dashboard.
|
||||
type: dict
|
||||
required: true
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
grafana_api_key:
|
||||
description:
|
||||
- CLoud API Key to authenticate with Grafana Cloud.
|
||||
- Grafana API Key to authenticate with Grafana Cloud.
|
||||
type: str
|
||||
required : true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
choices: [ present, absent ]
|
||||
default: present
|
||||
type: str
|
||||
|
@ -12,29 +12,29 @@ module: datasource
|
||||
author:
|
||||
- Ishan Jain (@ishanjainn)
|
||||
version_added: "0.0.1"
|
||||
short_description: Manage Data sources in Grafana
|
||||
short_description: Manage Data sources in Grafana Cloud
|
||||
description:
|
||||
- Create, Update and delete Data sources using Ansible.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
datasource:
|
||||
description:
|
||||
- JSON source code for the Data source
|
||||
- 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
|
||||
- Name of the Grafana Cloud stack to which the data source will be added.
|
||||
type: str
|
||||
required: true
|
||||
grafana_api_key:
|
||||
description:
|
||||
- CLoud API Key to authenticate with Grafana Cloud.
|
||||
- Grafana API Key to authenticate with Grafana Cloud.
|
||||
type: str
|
||||
required : true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
choices: [ present, absent ]
|
||||
default: present
|
||||
type: str
|
||||
|
@ -12,19 +12,19 @@ module: folder
|
||||
author:
|
||||
- Ishan Jain (@ishanjainn)
|
||||
version_added: "0.0.1"
|
||||
short_description: Manage Folders in Grafana
|
||||
short_description: Manage Folders in Grafana Cloud
|
||||
description:
|
||||
- Create, Update and delete Folders via Ansible.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
title:
|
||||
description:
|
||||
- The title of the folder.
|
||||
- Sets the title of the folder.
|
||||
type: str
|
||||
required: true
|
||||
uid:
|
||||
description:
|
||||
- unique identifier for your folder.
|
||||
- Sets the UID for your folder.
|
||||
type: str
|
||||
required: true
|
||||
overwrite:
|
||||
@ -40,12 +40,12 @@ options:
|
||||
required : true
|
||||
stack_slug:
|
||||
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
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- State for the Grafana CLoud stack.
|
||||
- State for the Grafana Cloud stack.
|
||||
choices: [ present, absent ]
|
||||
default: present
|
||||
type: str
|
||||
|
Loading…
Reference in New Issue
Block a user