grafana_plugin: update documentation (#60600)

This commit is contained in:
Theo Ouzhinski 2019-09-03 12:10:47 -04:00 committed by Sandra McCann
parent bdc87a5651
commit 9c1dc0ea7f

View file

@ -16,11 +16,12 @@ DOCUMENTATION = '''
--- ---
module: grafana_plugin module: grafana_plugin
author: author:
- Thierry Sallé (@tsalle) - Thierry Sallé (@seuf)
version_added: "2.5" version_added: "2.5"
short_description: Manage Grafana plugins via grafana-cli short_description: Manage Grafana plugins via grafana-cli
description: description:
- Install and remove Grafana plugins. - Install and remove Grafana plugins.
- See U(https://grafana.com/docs/plugins/installation/) for upstream documentation.
options: options:
name: name:
description: description:
@ -29,28 +30,31 @@ options:
version: version:
description: description:
- Version of the plugin to install. - Version of the plugin to install.
- Default to latest. - Defaults to C(latest).
grafana_plugins_dir: grafana_plugins_dir:
description: 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: grafana_repo:
description: 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: grafana_plugin_url:
description: 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. - Requires grafana 4.6.x or later.
state: state:
description: description:
- Status of the Grafana plugin. - Whether the plugin should be installed.
- If latest is set, the version parameter will be ignored. choices:
choices: [ absent, present ] - present
- absent
default: present default: present
''' '''
EXAMPLES = ''' EXAMPLES = '''
--- ---
- name: Install - update Grafana piechart panel plugin - name: Install/update Grafana piechart panel plugin
grafana_plugin: grafana_plugin:
name: grafana-piechart-panel name: grafana-piechart-panel
version: latest version: latest
@ -60,9 +64,9 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
--- ---
version: version:
description: version of the installed / removed plugin. description: version of the installed/removed/updated plugin.
type: str type: str
returned: allways returned: always
''' '''
import base64 import base64