chore: update documentation links (#1137)

splunk · Dec 6, 2024 · 527bd84 · 527bd84
1 parent 70bf3d2
commit 527bd84
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/dashboard/dashboard.xml b/dashboard/dashboard.xml
@@ -18,7 +18,7 @@
         </search>
       </input>
       <chart>
-        <title>In case of unsuccessful polling status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful polling status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/polling-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.snmp.tasks.poll "$poll_status_host$" | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>
@@ -92,7 +92,7 @@
         </search>
       </input>
       <chart>
-        <title>In case of unsuccessful walk status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful walk status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/polling-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.snmp.tasks.walk "$walk_status_host$" | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>
@@ -147,7 +147,7 @@
     <panel>
       <title>SNMP trap status</title>
       <chart>
-        <title>In case of unsuccessful trap status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful trap status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/traps-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.snmp.tasks.trap | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>
@@ -205,7 +205,7 @@
     <panel>
       <title>SNMP enrich task status</title>
       <chart>
-        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/polling-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.enrich.tasks.enrich | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>
@@ -221,7 +221,7 @@
     <panel>
       <title>SNMP prepare task status</title>
       <chart>
-        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/polling-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.splunk.tasks.prepare | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>
@@ -237,7 +237,7 @@
     <panel>
       <title>SNMP inventory poller task status</title>
       <chart>
-        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/bestpractices/</title>
+        <title>In case of unsuccessful enrich status, please copy spl query from this chart and find failed tasks. Explanation of error log messages you can find at the https://splunk.github.io/splunk-connect-for-snmp/main/troubleshooting/polling-issues/</title>
         <search>
           <query>index=* sourcetype="*:container:splunk-connect-for-snmp-*" splunk_connect_for_snmp.inventory.tasks.inventory_setup_poller | rex field=_raw "Task splunk_connect_for_snmp.*\[*\] (?&lt;status&gt;\w+)" | where status != "received" | timechart count by status</query>
           <earliest>-24h@h</earliest>

diff --git a/docs/dashboard.md b/docs/dashboard.md
@@ -6,7 +6,7 @@ show the status of SC4SNMP tasks.
 ## Presetting
 
 !!! info
-    Dashboard is compatible starting from version 1.11.0
+    Dashboard is compatible starting from version **1.11.0** and requires the `logLevel` set at least to **INFO**.
 
 1. [Create metrics index](microk8s/splunk-requirements.md#requirements-for-splunk-enterprise-or-enterprise-cloud) in Splunk.
 2. Enable metrics logging for your runtime:

diff --git a/docs/microk8s/configuration/values-params-description.md b/docs/microk8s/configuration/values-params-description.md
@@ -171,7 +171,7 @@ Detailed documentation about configuring traps can be found in [Traps](trap-conf
 | `service.externalTrafficPolicy`                 | Controls how Kubernetes routes traffic                                                                                          | `Local`          |
 | `service.ipv6Port`                              | Port of the service to use for IPv6                                                                                             | `162`            |
 | `service.ipv6NodePort`                          | Port when the `service.type` is `nodePort` and IPv6 is enabled                                                                  | `2163`           |
-| `loadBalancerIP`                                | Sets loadBalancer IP address in the metallb pool                                                                                | `30001`          |
+| `loadBalancerIP`                                | Sets loadBalancer IP address in the metallb pool                                                                                | ``               |
 | `ipFamilyPolicy`                                | Specifies if the service is dual stack or single stack                                                                          | `SingleStack`    |
 | `ipFamilies`                                    | Defines the address families used for chosen `ipFamilyPolicy`                                                                   | `IPv4`           |
 | `resources`                                     | CPU and memory limits and requests for pod                                                                                      |                  |

diff --git a/docs/microk8s/mk8s/k8s-microk8s.md b/docs/microk8s/mk8s/k8s-microk8s.md
@@ -70,8 +70,8 @@ When installing Metallb, you will be prompted for one or more IPs to use as entr
 into the cluster. If you plan to enable clustering, this IP should not be assigned to the host (floats).
 If you do not plan to cluster, then this IP should be the IP of your host.
 
-Note: a single IP in cidr format is `x.x.x.x/32`. Use CIDR or range syntax for single server installations. This can be
-the same as the primary IP.
+!!! info
+    Single IP in cidr format is `x.x.x.x/32`. Use CIDR or range syntax for single server installations. This can be the same as the primary IP.
 
 ```bash
 microk8s enable metallb

diff --git a/docs/microk8s/sc4snmp-installation.md b/docs/microk8s/sc4snmp-installation.md
@@ -182,10 +182,10 @@ index="netops" sourcetype="sc4snmp:event"
 | mpreview index="netmetrics" | search sourcetype="sc4snmp:metric"
 ```
 
-NOTE: Before polling starts, SC4SNMP must perform the SNMP WALK process on the device. It is run the first time after configuring the new device, and then during the run time in every `walk_interval`. 
-Its purpose is to gather all the data and provide meaningful context for the polling records. For example, it might report that your device is so large that the walk takes too long, so the scope of walking needs to be limited.
-In such cases, enable the small walk. See [walk takes too much time](../../troubleshooting/polling-issues/#walking-a-device-takes-too-much-time).
-When the walk finishes, events appear in Splunk.
+> **_NOTE:_** Before polling starts, SC4SNMP must perform the SNMP WALK process on the device. It is run the first time after configuring the new device, and then during the run time in every `walk_interval`. 
+> Its purpose is to gather all the data and provide meaningful context for the polling records. For example, it might report that your device is so large that the walk takes too long, so the scope of walking needs to be limited.
+> In such cases, enable the small walk. See [walk takes too much time](../../troubleshooting/polling-issues/#walking-a-device-takes-too-much-time).
+> When the walk finishes, events appear in Splunk.
 
 ## Next Steps
 

diff --git a/docs/microk8s/splunk-requirements.md b/docs/microk8s/splunk-requirements.md
@@ -13,8 +13,8 @@ See the following prerequisites for the Splunk Connect for SNMP.
        * netmetrics (metrics type)
        * netops (event type)
 
-Note: `netmetrics` and `netops` are the default names of SC4SNMP indexes. You can use the index names of your choice and
-reference it in the `values.yaml` file later on. See [SC4SNMP Parameters](sc4snmp-installation.md#configure-splunk-enterprise-or-splunk-cloud-connection) for details.
+> **_Note:_** `netmetrics` and `netops` are the default names of SC4SNMP indexes. You can use the index names of your choice and
+> reference it in the `values.yaml` file later on. See [SC4SNMP Parameters](sc4snmp-installation.md#configure-splunk-enterprise-or-splunk-cloud-connection) for details.
 
 2. Create or obtain a new Splunk HTTP Event Collector token and the correct HTTPS endpoint.
 3. Verify the token using [curl](https://docs.splunk.com/Documentation/Splunk/8.1.3/Data/FormateventsforHTTPEventCollector). The endpoint must use a publicly trusted certificate authority.