Merge pull request #45756 from roaldnefs/fix-grafana4-documentation

Fix Grafana4 states documentation

salt/states/grafana4_dashboard.py

@@ -4,17 +4,38 @@ Manage Grafana v4.0 Dashboards
 
 .. versionadded:: 2017.7.0
 
-.. code-block:: yaml
+:configuration: This state requires a configuration profile to be configured
+    in the minion config, minion pillar, or master config. The module will use
+    the 'grafana' key by default, if defined.
 
-    grafana:
-      grafana_timeout: 3
-      grafana_token: qwertyuiop
-      grafana_url: 'https://url.com'
+    Example configuration using basic authentication:
+
+    .. code-block:: yaml
+
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_user: admin
+          grafana_password: admin
+          grafana_timeout: 3
+
+    Example configuration using token based authentication:
+
+    .. code-block:: yaml
+
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_token: token
+          grafana_timeout: 3
+
+The behavior of this module is to create dashboards if they do not exist, to
+add rows if they do not exist in existing dashboards, and to update rows if
+they exist in dashboards. The module will not manage rows that are not defined,
+allowing users to manage their own custom rows.
 
 .. code-block:: yaml
 
     Ensure minimum dashboard is managed:
-      grafana_dashboard.present:
+      grafana4_dashboard.present:
         - name: insightful-dashboard
         - base_dashboards_from_pillar:
           - default_dashboard
@@ -30,12 +51,6 @@ Manage Grafana v4.0 Dashboards
                       - target: alias(constantLine(50), 'max')
                     title: Imaginary
                     type: graph
-
-
-The behavior of this module is to create dashboards if they do not exist, to
-add rows if they do not exist in existing dashboards, and to update rows if
-they exist in dashboards. The module will not manage rows that are not defined,
-allowing users to manage their own custom rows.
 '''
 
 # Import Python libs

salt/states/grafana4_datasource.py

@@ -4,31 +4,36 @@ Manage Grafana v4.0 data sources
 
 .. versionadded:: 2017.7.0
 
-Token auth setup
+:configuration: This state requires a configuration profile to be configured
+    in the minion config, minion pillar, or master config. The module will use
+    the 'grafana' key by default, if defined.
 
-.. code-block:: yaml
+    Example configuration using basic authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_token: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
 
-Basic auth setup
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_user: admin
+          grafana_password: admin
+          grafana_timeout: 3
 
-.. code-block:: yaml
+    Example configuration using token based authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_user: grafana
-      grafana_password: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
+
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_token: token
+          grafana_timeout: 3
+
+The bahavior of this module is to create data sources if the do not exists, and
+to update data sources if the already exists.
 
 .. code-block:: yaml
 
     Ensure influxdb data source is present:
-      grafana_datasource.present:
+      grafana4_datasource.present:
         - name: influxdb
         - type: influxdb
         - url: http://localhost:8086

salt/states/grafana4_org.py

@@ -4,26 +4,28 @@ Manage Grafana v4.0 orgs
 
 .. versionadded:: 2017.7.0
 
-Token auth setup
+:configuration: This state requires a configuration profile to be configured
+    in the minion config, minion pillar, or master config. The module will use
+    the 'grafana' key by default, if defined.
 
-.. code-block:: yaml
+    Example configuration using basic authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_token: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
 
-Basic auth setup
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_user: admin
+          grafana_password: admin
+          grafana_timeout: 3
 
-.. code-block:: yaml
+    Example configuration using token based authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_org: grafana
-      grafana_password: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
+
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_token: token
+          grafana_timeout: 3
 
 .. code-block:: yaml
 

salt/states/grafana4_user.py

@@ -4,26 +4,28 @@ Manage Grafana v4.0 users
 
 .. versionadded:: 2017.7.0
 
-Token auth setup
+:configuration: This state requires a configuration profile to be configured
+    in the minion config, minion pillar, or master config. The module will use
+    the 'grafana' key by default, if defined.
 
-.. code-block:: yaml
+    Example configuration using basic authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_token: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
 
-Basic auth setup
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_user: admin
+          grafana_password: admin
+          grafana_timeout: 3
 
-.. code-block:: yaml
+    Example configuration using token based authentication:
 
-    grafana_version: 4
-    grafana:
-      grafana_timeout: 5
-      grafana_user: grafana
-      grafana_password: qwertyuiop
-      grafana_url: 'https://url.com'
+    .. code-block:: yaml
+
+        grafana:
+          grafana_url: http://grafana.localhost
+          grafana_token: token
+          grafana_timeout: 3
 
 .. code-block:: yaml