From 2370ea34038bb4592df53ebb4bb2493296d1b651 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Wed, 26 Feb 2025 07:53:40 -0500 Subject: [PATCH] clarify Helm chart rootRulesFolder usage --- CHANGELOG.md | 1 + chart/elastalert2/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f81858b..f9a1e6fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ ## Other changes - Fix `schema.yaml` to support Kibana 8.17 - [#1631](https://github.com/jertel/elastalert2/pull/1631) - @vpiserchia +- [Helm] Clarified documentation around rootRulesFolder - [#1634](https://github.com/jertel/elastalert2/pull/1634) - @jertel # 2.23.0 diff --git a/chart/elastalert2/README.md b/chart/elastalert2/README.md index 1062fcd0..4b8dcac1 100644 --- a/chart/elastalert2/README.md +++ b/chart/elastalert2/README.md @@ -89,7 +89,7 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | ServiceAccount annotations | | | `podSecurityPolicy.create` | [DEPRECATED] Create pod security policy resources | `false` | | `resources` | Container resource requests and limits | {} | -| `rootRulesFolder` | Folder where rules will be read from during deployment time. By default, 'rules' must be in root of the chart. **Note:** this will override the rules and secretRulesName values. | `rules` | +| `rootRulesFolder` | **ONLY USE WITH EXPLODED CHART** Set this value to `rules` to read rules from the chart's `rules/` subdirectory. Be aware that Helm cannot read directories outside of the exploded chart's root directory. **Note:** this will override the rules and secretRulesName values. | `rules` | | `enabledRules` | Name of the active rules without file extension | `[]` | | `rulesVolumeName` | Specifies the rules volume to be mounted. Can be changed for mounting a custom rules folder via the extraVolumes parameter, instead of using the default rules configMap or secret rule mounting method. | "rules" | | `rules` | Rule and alert configuration for ElastAlert 2 | {} example shown in values.yaml |