From 629cc0b7e11e847a96d517f11446ec629289d6ea Mon Sep 17 00:00:00 2001 From: Ando Roots <116634474+sqrooted@users.noreply.github.com> Date: Fri, 6 Jan 2023 08:46:55 +0200 Subject: [PATCH 1/2] [docs] Clarify that import supports a list Ref #580 - documentation is misleading, it's now possible to have a rule import multiple additional configuration files, ie: ```yaml # my-rule.yml name: my-rule import: - $HOME/conf.d/base.yml - $HOME/conf.d/slack-alerter.yml ``` --- docs/source/ruletypes.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/ruletypes.rst b/docs/source/ruletypes.rst index 9e6fe535..fcc333a9 100644 --- a/docs/source/ruletypes.rst +++ b/docs/source/ruletypes.rst @@ -315,7 +315,8 @@ import ``import``: If specified includes all the settings from this yaml file. This allows common config options to be shared. Note that imported files that aren't complete rules should not have a ``.yml`` or ``.yaml`` suffix so that ElastAlert 2 doesn't treat them as rules. Filters in imported files are merged (ANDed) -with any filters in the rule. You can only have one import per rule, though the imported file can import another file or multiple files, recursively. +with any filters in the rule. You can have one import per rule (value is string) or several imports per rule (value is a list of strings). +The imported file can import another file or multiple files, recursively. The filename can be an absolute path or relative to the rules directory. (Optional, string or array of strings, no default) use_ssl From b434a2406dc7d2bf34e96a50a6fe3bd56197b2ff Mon Sep 17 00:00:00 2001 From: Ando Roots <116634474+sqrooted@users.noreply.github.com> Date: Fri, 6 Jan 2023 08:51:35 +0200 Subject: [PATCH 2/2] Update CHANGELOG for docs import directive --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b091b986..bbfb0d34 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ## Other changes - [Docs] Clarify Jira Cloud authentication configuration - [94f7e8c](https://github.com/jertel/elastalert2/commit/94f7e8cc98d59a00349e3b23acd8a8549c80dbc8) - @jertel - Update minimum versions for third-party dependencies in requirements.txt and setup.py - [#1051](https://github.com/jertel/elastalert2/pull/1051) - @nsano-rururu +- [Docs] Clarify `import` support for list of files [#1075](https://github.com/jertel/elastalert2/pull/1075) - @sqrooted # 2.9.0