Merge pull request #11960 from Security-Onion-Solutions/2.4/fix-config-links

FIX: Documentation links under SOC - Administration - Configuration need updating #11828

salt/elasticsearch/soc_elasticsearch.yaml

@@ -8,7 +8,7 @@ elasticsearch:
   retention: 
     retention_pct:
       decription: Total percentage of space used by Elasticsearch for multi node clusters
-      helpLink: elasticsearch.yaml
+      helpLink: elasticsearch.html
       global: True
   config:
     cluster:

salt/firewall/soc_firewall.yaml

@@ -3,14 +3,14 @@ firewall:
     analyst: &hostgroupsettings
       description: List of IP or CIDR blocks to allow access to this hostgroup.
       forcedType: "[]string"
-      helplink: firewall.html
+      helpLink: firewall.html
       multiline: True
       regex: ^(([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?)?$
       regexFailureMessage: You must enter a valid IP address or CIDR.
     anywhere: &hostgroupsettingsadv
       description: List of IP or CIDR blocks to allow access to this hostgroup.
       forcedType: "[]string"
-      helplink: firewall.html
+      helpLink: firewall.html
       multiline: True
       advanced: True
       regex: ^(([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?)?$
@@ -20,7 +20,7 @@ firewall:
     dockernet: &ROhostgroupsettingsadv
       description: List of IP or CIDR blocks to allow access to this hostgroup.
       forcedType: "[]string"
-      helplink: firewall.html
+      helpLink: firewall.html
       multiline: True
       advanced: True
       readonly: True
@@ -67,13 +67,13 @@ firewall:
       tcp: &tcpsettings
         description: List of TCP ports for this port group.
         forcedType: "[]string"
-        helplink: firewall.html
+        helpLink: firewall.html
         advanced: True
         multiline: True
       udp: &udpsettings
         description: List of UDP ports for this port group.
         forcedType: "[]string"
-        helplink: firewall.html
+        helpLink: firewall.html
         advanced: True
         multiline: True
     agrules:

salt/idh/soc_idh.yaml

@@ -80,9 +80,9 @@ idh:
       http_x_enabled: *serviceOptions
       http_x_port: *portOptions
       http_x_skin: &skinOptions
-        description:
+        description: HTTP skin
         advanced: True
-        helplink: idh.html
+        helpLink: idh.html
       http_x_skinlist: &skinlistOptions
         description: List of skins to use for the service.
         advanced: True

salt/manager/soc_manager.yaml

@@ -3,28 +3,28 @@ manager:
     enabled:
       description: This is the daily task of syncing the Security Onion OS packages. It is recommended that you leave this enabled.
       global: True
-      helpLink: manager.html
+      helpLink: soup.html
     hour:
       description: The hour of the day in which the repo sync takes place.
       global: True
-      helpLink: manager.html 
+      helpLink: soup.html 
     minute:
       description: The minute within the hour to run the repo sync.
       global: True
-      helpLink: manager.html
+      helpLink: soup.html
   elastalert:
     description: Enable elastalert 1=enabled 0=disabled.
     global: True
-    helpLink: manager.html
+    helpLink: elastalert.html
   no_proxy: 
     description: String of hosts to ignore the proxy settings for. 
     global: True
-    helpLink: manager.html
+    helpLink: proxy.html
   playbook:
     description: Enable playbook 1=enabled 0=disabled.
     global: True
-    helpLink: manager.html
+    helpLink: playbook.html
   proxy:
     description: Proxy server to use for updates.
     global: True
-    helpLink: manager.html
+    helpLink: proxy.html

salt/patch/soc_patch.yaml

@@ -2,19 +2,19 @@ patch:
   os:
     enabled:
       description: Enable OS updates. 
-      helpLink: patch.html
+      helpLink: soup.html
     schedule_to_run: 
       description: Currently running schedule for updates.
-      helpLink: patch.html
+      helpLink: soup.html
     schedules:
       auto:
         splay: &splayOptions
           description: Seconds to splay updates.
-          helpLink: patch.html 
+          helpLink: soup.html 
         schedule:
           hours: 
             description: Run the OS updates every X hours. 
-            helpLink: patch.html
+            helpLink: soup.html
       monday:
         splay: *splayOptions
         schedule: 
@@ -51,7 +51,7 @@ patch:
           Monday: &dailyOptions
             description: List of times to apply OS patches daily.
             multiline: True
-            helpLink: True
+            helpLink: soup.html
           Tuesday: *dailyOptions
           Wednesday: *dailyOptions
           Thursday: *dailyOptions
@@ -64,7 +64,7 @@ patch:
           Monday: &weekdayOptions
             description: List of times for weekdays.
             multiline: True
-            helplink: patch.html
+            helpLink: soup.html
           Tuesday: *weekdayOptions
           Wednesday: *weekdayOptions
           Thursday: *weekdayOptions
@@ -73,7 +73,7 @@ patch:
         splay: *splayOptions
         schedule:
           Saturday: &weekendOptions
-            description:
+            description: List of times for weekend days.
             multiline: true
-            helpLink: patch.html
+            helpLink: soup.html
           Sunday: *weekendOptions

salt/soctopus/soc_soctopus.yaml

@@ -1,10 +1,10 @@
 soctopus:
   enabled:
     description: You can enable or disable SOCtopus.
-    helpLink: soctopus.html
+    helpLink: playbook.html
   playbook:
     rulesets:
       description: List of playbook rulesets.
       advanced: True
-      helplink: soctopus.html
+      helpLink: playbook.html
       global: True

salt/telegraf/soc_telegraf.yaml

@@ -1,54 +1,54 @@
 telegraf:
   enabled: 
     description: You can enable or disable Telegraf.
-    helpLink: telegraf.html
+    helpLink: influxdb.html
   config:
     interval:
       description: Data collection interval.
       global: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     metric_batch_size: 
       description: Data collection batch size.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     metric_buffer_limit:
       description: Data collection buffer size.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     collection_jitter: 
       description: Jitter of the flush interval.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     flush_interval:
       description: Flush interval for all outputs.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     flush_jitter: 
       description: Jitter the flush interval.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     debug: 
       description: Data collection interval.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     quiet: 
       description: Data collection interval.
       global: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
   scripts:
     eval: &telegrafscripts
       description: List of input.exec scripts to run for this node type. The script must be present in salt/telegraf/scripts.
       forcedType: "[]string"
       multiline: True
       advanced: True
-      helpLink: telegraf.html
+      helpLink: influxdb.html
     standalone: *telegrafscripts
     manager: *telegrafscripts
     managersearch: *telegrafscripts