fix: value name and comments

Signed-off-by: David Calvert <david@0xdc.me>
falcosecurity · Apr 15, 2024 · 138eb3a · 138eb3a
1 parent 51a377c
commit 138eb3a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/charts/falco-exporter/README.md b/charts/falco-exporter/README.md
@@ -84,10 +84,10 @@ The following table lists the main configurable parameters of the falco-exporter
 | falco.grpcTimeout | string | `"2m"` | grpcTimeout timout value for grpc connection. |
 | falco.grpcUnixSocketPath | string | `"unix:///run/falco/falco.sock"` | grpcUnixSocketPath path to the falco's grpc unix socket. |
 | fullnameOverride | string | `""` | fullNameOverride same as nameOverride but for the full name. |
-| grafanaDashboard | object | `{"enabled":false,"folder":"","folder_annotation":"grafana_dashboard_folder","namespace":"default","prometheusDatasourceName":"Prometheus"}` | grafanaDashboard contains the configuration related to grafana dashboards. |
+| grafanaDashboard | object | `{"enabled":false,"folder":"","folderAnnotation":"grafana_dashboard_folder","namespace":"default","prometheusDatasourceName":"Prometheus"}` | grafanaDashboard contains the configuration related to grafana dashboards. |
 | grafanaDashboard.enabled | bool | `false` | enabled specifies whether the dashboard should be deployed. |
-| grafanaDashboard.folder | string | `""` | create and set folder_annotation to specify where the dashboard is stored in grafana. |
-| grafanaDashboard.folder_annotation | string | `"grafana_dashboard_folder"` | annotation used by grafana when using folderAnnotation. |
+| grafanaDashboard.folder | string | `""` | folder creates and set folderAnnotation to specify where the dashboard is stored in grafana. |
+| grafanaDashboard.folderAnnotation | string | `"grafana_dashboard_folder"` | folderAnnotation sets the annotation's name used by folderAnnotation in grafana's helm-chart. |
 | grafanaDashboard.namespace | string | `"default"` | namespace specifies the namespace for the configmap. |
 | grafanaDashboard.prometheusDatasourceName | string | `"Prometheus"` | prometheusDatasourceName name of the data source. |
 | healthChecks | object | `{"livenessProbe":{"initialDelaySeconds":60,"periodSeconds":15,"probesPort":19376,"timeoutSeconds":5},"readinessProbe":{"initialDelaySeconds":30,"periodSeconds":15,"probesPort":19376,"timeoutSeconds":5}}` | healthChecks contains the configuration for liveness and readiness probes. |

diff --git a/charts/falco-exporter/templates/grafana-dashboard.yaml b/charts/falco-exporter/templates/grafana-dashboard.yaml
@@ -305,7 +305,7 @@ metadata:
   {{- if .Values.grafanaDashboard.folder }}
   annotations:
     k8s-sidecar-target-directory: /tmp/dashboards/{{ .Values.grafanaDashboard.folder }}
-    {{ .Values.grafanaDashboard.folder_annotation }}: {{ .Values.grafanaDashboard.folder }}
+    {{ .Values.grafanaDashboard.folderAnnotation }}: {{ .Values.grafanaDashboard.folder }}
   {{- end }}
   name: grafana-falco
   {{- if .Values.grafanaDashboard.namespace }}

diff --git a/charts/falco-exporter/values.yaml b/charts/falco-exporter/values.yaml
@@ -175,10 +175,10 @@ serviceMonitor:
 grafanaDashboard:
   # -- enabled specifies whether the dashboard should be deployed.
   enabled: false
-  # -- create and set folder_annotation to specify where the dashboard is stored in grafana.
+  # -- folder creates and set folderAnnotation to specify where the dashboard is stored in grafana.
   folder: ""
-  # -- annotation used by grafana when using folderAnnotation.
-  folder_annotation: "grafana_dashboard_folder"
+  # -- folderAnnotation sets the annotation's name used by folderAnnotation in grafana's helm-chart.
+  folderAnnotation: "grafana_dashboard_folder"
   # -- namespace specifies the namespace for the configmap.
   namespace: default
   # -- prometheusDatasourceName name of the data source.