Merge pull request #47740 from garethgreenaway/46938_beacons_documentation

[2018.3] Updating Beacon topic to include list based configuration for Beacons

doc/topics/beacons/index.rst

@@ -40,8 +40,9 @@ Beacons are typically enabled by placing a ``beacons:`` top level block in
 
     beacons:
       inotify:
-        /etc/important_file: {}
-        /opt: {}
+        - files:
+            /etc/important_file: {}
+            /opt: {}
 
 The beacon system, like many others in Salt, can also be configured via the
 minion pillar, grains, or local config file.
@@ -50,6 +51,8 @@ minion pillar, grains, or local config file.
     The `inotify` beacon only works on OSes that have `inotify` kernel support.
     Currently this excludes FreeBSD, macOS, and Windows.
 
+All beacon configuration is done using list based configuration.
+
 Beacon Monitoring Interval
 --------------------------
 
@@ -61,21 +64,23 @@ and 10-second intervals:
 
     beacons:
       inotify:
-        /etc/important_file: {}
-        /opt: {}
-        interval: 5
-        disable_during_state_run: True
+        - files:
+            /etc/important_file: {}
+            /opt: {}
+        - interval: 5
+        - disable_during_state_run: True
       load:
-        1m:
-          - 0.0
-          - 2.0
-        5m:
-          - 0.0
-          - 1.5
-        15m:
-          - 0.1
-          - 1.0
-        interval: 10
+        - averages:
+            1m:
+              - 0.0
+              - 2.0
+            5m:
+              - 0.0
+              - 1.5
+            15m:
+              - 0.1
+              - 1.0
+        - interval: 10
 
 .. _avoid-beacon-event-loops:
 
@@ -96,8 +101,9 @@ which point the normal beacon interval will resume.
 
     beacons:
       inotify:
-        /etc/important_file: {}
-        disable_during_state_run: True
+        - files:
+            /etc/important_file: {}
+        - disable_during_state_run: True
 
 .. _beacon-example:
 
@@ -137,10 +143,11 @@ On the Salt minion, add the following configuration to
 
     beacons:
       inotify:
-        /etc/important_file:
-          mask:
-            - modify
-        disable_during_state_run: True
+        - files:
+            /etc/important_file:
+              mask:
+                - modify
+        - disable_during_state_run: True
 
 Save the configuration file and restart the minion service. The beacon is now
 set up to notify salt upon modifications made to the file.