From 9c1dc0ea7f6687d4c902969d46a0f36a3e90d038 Mon Sep 17 00:00:00 2001
From: Theo Ouzhinski <32401143+theo-o@users.noreply.github.com>
Date: Tue, 3 Sep 2019 12:10:47 -0400
Subject: [PATCH] grafana_plugin: update documentation (#60600)
---
.../modules/monitoring/grafana_plugin.py | 26 +++++++++++--------
1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/lib/ansible/modules/monitoring/grafana_plugin.py b/lib/ansible/modules/monitoring/grafana_plugin.py
index 0f025a3f429..418253a108f 100644
--- a/lib/ansible/modules/monitoring/grafana_plugin.py
+++ b/lib/ansible/modules/monitoring/grafana_plugin.py
@@ -16,11 +16,12 @@ DOCUMENTATION = '''
---
module: grafana_plugin
author:
- - Thierry Sallé (@tsalle)
+ - Thierry Sallé (@seuf)
version_added: "2.5"
short_description: Manage Grafana plugins via grafana-cli
description:
- Install and remove Grafana plugins.
+ - See U(https://grafana.com/docs/plugins/installation/) for upstream documentation.
options:
name:
description:
@@ -29,28 +30,31 @@ options:
version:
description:
- Version of the plugin to install.
- - Default to latest.
+ - Defaults to C(latest).
grafana_plugins_dir:
description:
- - Directory where Grafana plugin will be installed.
+ - Directory where the Grafana plugin will be installed.
+ - If omitted, defaults to C(/var/lib/grafana/plugins).
grafana_repo:
description:
- - Grafana repository. If not set, gafana-cli will use the default value C(https://grafana.net/api/plugins).
+ - URL to the Grafana plugin repository.
+ - "If omitted, grafana-cli will use the default value: U(https://grafana.com/api/plugins)."
grafana_plugin_url:
description:
- - Custom Grafana plugin URL.
+ - Full URL to the plugin zip file instead of downloading the file from U(https://grafana.com/api/plugins).
- Requires grafana 4.6.x or later.
state:
description:
- - Status of the Grafana plugin.
- - If latest is set, the version parameter will be ignored.
- choices: [ absent, present ]
+ - Whether the plugin should be installed.
+ choices:
+ - present
+ - absent
default: present
'''
EXAMPLES = '''
---
-- name: Install - update Grafana piechart panel plugin
+- name: Install/update Grafana piechart panel plugin
grafana_plugin:
name: grafana-piechart-panel
version: latest
@@ -60,9 +64,9 @@ EXAMPLES = '''
RETURN = '''
---
version:
- description: version of the installed / removed plugin.
+ description: version of the installed/removed/updated plugin.
type: str
- returned: allways
+ returned: always
'''
import base64