chore(helm): rename helm field config file (#4018)

* chore(helm): rename helm field config file and fix docs
aquasecurity · May 16, 2024 · a458fa9 · a458fa9
1 parent fb292ed
commit a458fa9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/deploy/helm/tracee/templates/tracee-config.yaml b/deploy/helm/tracee/templates/tracee-config.yaml
@@ -6,9 +6,9 @@ metadata:
   labels:
     {{- include "tracee.labels" . | nindent 4 }}
 data:
-  {{- if .Values.traceeConfig }}
+  {{- if .Values.configFile }}
   config.yaml:
-    {{- toYaml .Values.traceeConfig | nindent 4 }}
+    {{- toYaml .Values.configFile | nindent 4 }}
   {{- else }}
   config.yaml: |-
     cache:

diff --git a/deploy/helm/tracee/values.yaml b/deploy/helm/tracee/values.yaml
@@ -57,7 +57,7 @@ affinity: {}
 webhook: ""
 
 # extraWebhookTemplates is a list of additional webhook templates that can be used by
-# the traceeConfig or config.output.webhook fields
+# the configFile or config.output.webhook fields
 # in the example below, the goTemplate content will be mounted as /tracee/templates/template1.tmpl
 extraWebhookTemplates: []
 # - name: "template1.tmpl"
@@ -74,8 +74,12 @@ extraWebhookTemplates: []
 #     }
 #   }
 
-traceeConfig: {}
+# The configFile field specifies the Tracee configuration file path and can be
+# changed directly via CLI command using --set-file configFile=myconfig.yaml
+configFile: {}
 
+# This config field holds default values for Tracee configuration and each field
+# can be changed individually via CLI command, using --set config.field=value
 config:
   blobPerfBufferSize: ""
   perfBufferSize: 1024
@@ -101,7 +105,7 @@ config:
       execHash: dev-inode
       sortEvents: false
     # uncomment config.output.webhook to enable a single webhook
-    # to configure multiple webhooks, use the traceeConfig field
+    # to configure multiple webhooks, use the configFile field
     # webhook:
     #   name: "webhook1"
     #   contentType: "application/json"

diff --git a/docs/docs/install/config/kubernetes.md b/docs/docs/install/config/kubernetes.md
@@ -57,5 +57,5 @@ or to provide a complete config file:
 ```
  helm install tracee aqua/tracee \
         --namespace tracee --create-namespace \
-        --set-file traceeConfig=myconfig.yaml
+        --set-file configFile=myconfig.yaml
 ```