chore: describe values (#1035)

charts/splunk-connect-for-snmp/templates/common/scheduler-config.yaml

@@ -6,10 +6,6 @@ metadata:
     {{- include "splunk-connect-for-snmp.scheduler.labels" . | nindent 4 }}
 data:
   config.yaml: |-
-{{- if (.Values.scheduler).usernames }}
-      usernames:
-{{ .Values.scheduler.usernames | indent 8 -}}
-{{ end }}
 {{- if (.Values.scheduler).profiles }}
       profiles:
 {{ .Values.scheduler.profiles | indent 8 -}}

charts/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -59,8 +59,6 @@ spec:
               value: "http://{{ printf "%s-%s" .Release.Name "mibserver" }}/standard.txt"
             - name: LOG_LEVEL
               value: {{ .Values.scheduler.logLevel | default "INFO" }}
-            - name: INVENTORY_REFRESH_RATE
-              value: {{ .Values.scheduler.inventory_refresh_rate | default "600" | quote }}
           volumeMounts:
             - name: config
               mountPath: "/app/config"

charts/splunk-connect-for-snmp/templates/worker/_helpers.tpl

@@ -164,23 +164,23 @@ Common labels
 
 {{- define "environmental-variables-poller" -}}
 - name: WORKER_CONCURRENCY
-  value: {{ .Values.worker.poller.concurrency | default "2" | quote }}
+  value: {{ .Values.worker.poller.concurrency | default "4" | quote }}
 - name: PREFETCH_COUNT
   value: {{ .Values.worker.poller.prefetch | default "1" | quote }}
 {{- end }}
 
 {{- define "environmental-variables-sender" -}}
 - name: WORKER_CONCURRENCY
-  value: {{ .Values.worker.sender.concurrency | default "2" | quote }}
+  value: {{ .Values.worker.sender.concurrency | default "4" | quote }}
 - name: PREFETCH_COUNT
-  value: {{ .Values.worker.sender.prefetch | default "1" | quote }}
+  value: {{ .Values.worker.sender.prefetch | default "30" | quote }}
 {{- end }}
 
 {{- define "environmental-variables-trap" -}}
 - name: WORKER_CONCURRENCY
-  value: {{ .Values.worker.trap.concurrency | default "2" | quote }}
+  value: {{ .Values.worker.trap.concurrency | default "4" | quote }}
 - name: PREFETCH_COUNT
-  value: {{ .Values.worker.trap.prefetch | default "1" | quote }}
+  value: {{ .Values.worker.trap.prefetch | default "30" | quote }}
 - name: RESOLVE_TRAP_ADDRESS
   value: {{ .Values.worker.trap.resolveAddress.enabled | default "false" | quote }}
 - name: MAX_DNS_CACHE_SIZE_TRAPS

charts/splunk-connect-for-snmp/values.yaml

@@ -30,6 +30,7 @@ UI:
     repository: ghcr.io/splunk/sc4snmp-ui/backend/container
     tag: "main"
     pullPolicy: "Always"
+  # Base container that sets permissions for folders mounted to UI containers
   init:
     repository: registry.access.redhat.com/ubi9/ubi
     pullPolicy: IfNotPresent
@@ -70,7 +71,7 @@ splunk:
   token: 00000000-0000-0000-0000-000000000000
   # Whether to skip checking the certificate of the HEC endpoint when sending
   # data over HTTPS.
-  insecureSSL: "true"
+  insecureSSL: "false"
 
   # sourcetype for trap events
   sourcetypeTraps: "sc4snmp:traps"
@@ -94,11 +95,10 @@ splunk:
 sim:
   # Enables sending data to Splunk Observability/SignalFx.
   enabled: false
-
-  # Splunk Observability realm to send telemetry data to.
-  signalfxToken: ""
-  # Required for Splunk Observability (if `realm` is specified).
   # Splunk Observability org access token.
+  # Required for Splunk Observability (if `realm` is specified).
+  signalfxToken: ""
+  # Splunk Observability realm to send telemetry data to.
   signalfxRealm: ""
 
   resources: {}

docker_compose/docker-compose-scheduler.yaml

@@ -12,7 +12,6 @@ services:
       - MIB_SOURCES=http://snmp-mibserver:8000/asn1/@mib@
       - MIB_INDEX=http://snmp-mibserver:8000/index.csv
       - MIB_STANDARD=http://snmp-mibserver:8000/standard.txt
-      - INVENTORY_REFRESH_RATE=${INVENTORY_REFRESH_RATE:-600}
 
       # Scheduler configuration
       - LOG_LEVEL=${SCHEDULER_LOG_LEVEL:-INFO}

docker_compose/docker-compose-traps.yaml

@@ -18,7 +18,6 @@ services:
     - MIB_INDEX=http://snmp-mibserver:8000/index.csv
     - MIB_STANDARD=http://snmp-mibserver:8000/standard.txt
     - LOG_LEVEL=${TRAP_LOG_LEVEL:-INFO}
-    - INVENTORY_REFRESH_RATE=${INVENTORY_REFRESH_RATE:-600}
     - SPLUNK_HEC_HOST=${SPLUNK_HEC_HOST}
     - SPLUNK_HEC_SCHEME=${SPLUNK_HEC_PROTOCOL:-https}
     - SPLUNK_HEC_PORT=${SPLUNK_HEC_PORT}

docs/gui/enable-gui.md

@@ -25,6 +25,7 @@ UI:
 - `valuesFileName`: [OPTIONAL] full name of the file with configuration (e.g. `values.yaml`) that is stored inside the `valuesFileDirectory` directory. If this file name is provided, and it exists in this directory, then GUI will update appropriate sections in provided `values.yaml` file. If this file name is not provided, or provided file name can’t be found inside `valuesFileDirectory` then inside that directory there will be created three files with the latest GUI configuration of groups, profiles and inventory. Those configuration can be copied and pasted to the appropriate sections in the original `values.yaml` file.
 
   Template of initial `values.yaml`:
+
     ```yaml
     scheduler:
       profiles: |

rendered/manifests/tests/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_autoscaling_enabled/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_autoscaling_enabled_deprecated/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_enable_ui/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_only_polling/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_probes_enabled/splunk-connect-for-snmp/templates/scheduler/deployment.yaml

@@ -58,8 +58,6 @@ spec:
               value: "http://release-name-mibserver/standard.txt"
             - name: LOG_LEVEL
               value: INFO
-            - name: INVENTORY_REFRESH_RATE
-              value: "600"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

splunk_connect_for_snmp/poller.py

@@ -42,7 +42,6 @@
 # app.conf.update(**config)
 
 INVENTORY_PATH = os.getenv("INVENTORY_PATH", "/app/inventory/inventory.csv")
-INVENTORY_REFRESH_RATE = int(os.getenv("INVENTORY_REFRESH_RATE", "600"))
 
 app.autodiscover_tasks(
     packages=[