You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/core_component_syncing_rules_and_data_from_vcs_to_elastic_security.md
+2-12Lines changed: 2 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -113,7 +113,7 @@ Commands:
113
113
...
114
114
```
115
115
116
-
💡 Note: For stacks with a version prior to 9.0, one can use the `kibana upload-rule` command. However, this is not recommended and one should use the `kibana import-rules` in its place.
116
+
💡 Note: For stacks with a version prior to 9.0, one can use the `kibana upload-rule` command. However, this is not recommended and one should use the `kibana import-rules` in its place. See the [CLI.md](https://github.com/elastic/detection-rules/blob/main/CLI.md) for more details.
Copy file name to clipboardExpand all lines: docs/internals_of_the_detection_rules_repo.md
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -170,27 +170,28 @@ The repository extensively utilizes schemas sourced from upstream (e.g., Beats,
170
170
1. Explore the [rule dataclasses](https://github.com/elastic/detection-rules/blob/main/detection_rules/rule.py) detailed in the repository to understand the expected format for rule definitions. These are periodically updated to reflect new capabilities within the Kibana features set.
171
171
172
172
```python
173
-
@dataclass(frozen=True)
173
+
@dataclass(frozen=True, kw_only=True)
174
174
class RuleMeta(MarshmallowDataclassMixin):
175
175
"""Data stored in a rule's [metadata] section of TOML."""
2. Visit the etc/ directory within the repository to review additional resources, including validation schemas and configuration files required for rule management and development.
Copy file name to clipboardExpand all lines: docs/known_limitations.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,11 +15,10 @@
15
15
16
16
## No Direct Support
17
17
18
-
- Managing prebuilt rules via DaC workflows is not supported at the moment (this is being addressed).
19
18
- Rule loading
20
19
- Core repo (loading Rule object)
21
-
- Officially supports from TOML to Rule object
22
-
- Support for json yaml will exist but will remain in a dict format
20
+
- Officially supports loading from TOML to Rule object
21
+
- Support for json and yaml exists but will remain in a dict format (as opposed to the nested TOML format)
23
22
- This is only a convenience utility and will only be supported across minimal components, since all functionality depends on the validated object (and related pieces)
24
23
- Kibana module does support raw dict's
25
24
- We added a RawDictLoader as a util, but this will only serve to load rules to dicts, bypassing most of the value of the core repo
@@ -32,6 +31,7 @@
32
31
## Potential Upcoming Enhancements
33
32
34
33
- Support for customizable folder structure:
35
-
- There currently is no support for customizing the folder structure which decides how rules are stored on disk when downloaded from kibana (however, this can also be reconciled post download in whatever manner desired).
34
+
- There currently is not full support for customizing the folder structure which decides how rules are stored on disk.
36
35
- This means that users have to manually move rules to specific organized folders.
37
-
- This is tracked in: [#3625](https://github.com/elastic/detection-rules/issues/3625)
36
+
- This is tracked in: [#3625](https://github.com/elastic/detection-rules/issues/3625)
37
+
- However, there is support for using an existing folder structure when importing rules from a Kibana export. This is done by using the `--load-rule-loading / -lr` option in the `kibana export-rules` and `import-rules-to-repo` commands. See [#4891](https://github.com/elastic/detection-rules/issues/4891) and its associated PR for more details.
0 commit comments