From f1f0ee24e953a2283de8e35ccfdf1bfd0062191c Mon Sep 17 00:00:00 2001 From: Mickael Alliel Date: Mon, 30 Sep 2024 09:24:32 -0400 Subject: [PATCH] add documentation for redaction.secret.keepOnlyHelmRelease (#333) --- charts/komodor-agent/README.md | 3 ++- charts/komodor-agent/values.yaml | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/charts/komodor-agent/README.md b/charts/komodor-agent/README.md index c6402286..6decc8d4 100644 --- a/charts/komodor-agent/README.md +++ b/charts/komodor-agent/README.md @@ -136,8 +136,9 @@ The command removes all the Kubernetes components associated with the chart and | capabilities.logs.nameDenylist | list | `[]` | Do not fetch logs from these workloads. eg. `["supersecret-workload", "password-manager"]` | | capabilities.logs.redact | list | `[]` | Redact logs from the komodor logs. eg. `["password", "token"]` | | capabilities.redaction | object | See sub-values | Configure the agent data redaction capabilities | -| capabilities.redaction.secret | object | `{"enable":true}` | Configuration for the "Secret" resource type | +| capabilities.redaction.secret | object | `{"enable":true,"keepOnlyHelmReleases":false}` | Configuration for the "Secret" resource type | | capabilities.redaction.secret.enable | bool | `true` | Enable redaction for the "Secret" resource type | +| capabilities.redaction.secret.keepOnlyHelmReleases | bool | `false` | Determine if only helm releases should be collected, if true - wipe and redact all other secrets data | | capabilities.telemetry | object | See sub-values | Configure the agent telemetry capabilities | | capabilities.telemetry.enabled | bool | `true` | Enable telemetry capabilities by the komodor agent | | capabilities.telemetry.collectApiServerMetrics | bool | `false` | Collect metrics from the api server (Should only be used for debugging purposes) | diff --git a/charts/komodor-agent/values.yaml b/charts/komodor-agent/values.yaml index e855d3a5..19c20000 100644 --- a/charts/komodor-agent/values.yaml +++ b/charts/komodor-agent/values.yaml @@ -114,6 +114,8 @@ capabilities: secret: # capabilities.redaction.secret.enable -- (bool) Enable redaction for the "Secret" resource type enable: true + # capabilities.redaction.secret.keepOnlyHelmReleases -- (bool) Determine if only helm releases should be collected, if true - wipe and redact all other secrets data + keepOnlyHelmReleases: false # capabilities.telemetry -- Configure the agent telemetry capabilities # @default -- See sub-values