Skip to content

Commit

Permalink
[8.x] [Security Solution] Test plan for upgrading prebuilt rules with…
Browse files Browse the repository at this point in the history
… preview (Rule Upgrade flyout) v1 (#205645) (#211250)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Security Solution] Test plan for upgrading prebuilt rules with
preview (Rule Upgrade flyout) v1
(#205645)](#205645)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Maxim
Palenov","email":"maxim.palenov@elastic.co"},"sourceCommit":{"committedDate":"2025-02-14T15:21:09Z","message":"[Security
Solution] Test plan for upgrading prebuilt rules with preview (Rule
Upgrade flyout) v1 (#205645)\n\n**Epics:**
https://github.com/elastic/security-team/issues/1974\r\n(internal),
https://github.com/elastic/kibana/issues/174168\r\n**Addresses:**
https://github.com/elastic/kibana/issues/202078\r\n\r\n##
Summary\r\n\r\nThis PR adds a test plan for rule upgrade
flyout.\r\n\r\n---------\r\n\r\nCo-authored-by: Georgii Gorbachev
<georgii.gorbachev@elastic.co>","sha":"ecd33168b152d0c268d4cec7881deedeb7628814","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","test-plan","v9.0.0","Team:Detections
and Resp","Team: SecuritySolution","Team:Detection Rule
Management","Feature:Prebuilt Detection
Rules","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security
Solution] Test plan for upgrading prebuilt rules with preview (Rule
Upgrade flyout)
v1","number":205645,"url":"https://github.com/elastic/kibana/pull/205645","mergeCommit":{"message":"[Security
Solution] Test plan for upgrading prebuilt rules with preview (Rule
Upgrade flyout) v1 (#205645)\n\n**Epics:**
https://github.com/elastic/security-team/issues/1974\r\n(internal),
https://github.com/elastic/kibana/issues/174168\r\n**Addresses:**
https://github.com/elastic/kibana/issues/202078\r\n\r\n##
Summary\r\n\r\nThis PR adds a test plan for rule upgrade
flyout.\r\n\r\n---------\r\n\r\nCo-authored-by: Georgii Gorbachev
<georgii.gorbachev@elastic.co>","sha":"ecd33168b152d0c268d4cec7881deedeb7628814"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205645","number":205645,"mergeCommit":{"message":"[Security
Solution] Test plan for upgrading prebuilt rules with preview (Rule
Upgrade flyout) v1 (#205645)\n\n**Epics:**
https://github.com/elastic/security-team/issues/1974\r\n(internal),
https://github.com/elastic/kibana/issues/174168\r\n**Addresses:**
https://github.com/elastic/kibana/issues/202078\r\n\r\n##
Summary\r\n\r\nThis PR adds a test plan for rule upgrade
flyout.\r\n\r\n---------\r\n\r\nCo-authored-by: Georgii Gorbachev
<georgii.gorbachev@elastic.co>","sha":"ecd33168b152d0c268d4cec7881deedeb7628814"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co>
  • Loading branch information
kibanamachine and maximpn authored Feb 14, 2025
1 parent 0f932dc commit 273f2c1
Show file tree
Hide file tree
Showing 3 changed files with 756 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,49 +2,47 @@

These are fields in the detection rule schema that are able to be customized on a prebuilt rule.

| field_name |
| name |
| description |
| interval |
| from |
| to |
| note |
| severity |
| tags |
| severity_mapping |
| risk_score |
| risk_score_mapping |
| references |
| false_positives |
| threat |
| note |
| setup |
| related_integrations |
| required_fields |
| max_signals |
| investigation_fields |
| rule_name_override |
| timestamp_override |
| timeline_template |
| building_block_type |
| query |
| language |
| filters |
| index |
| data_view_id |
| alert_suppression |
| event_category_override |
| timestamp_field |
| tiebreaker_field |
| threat_index |
| threat_mapping |
| threat_indicator_path |
| threat_query |
| threat_language |
| threat_filters |
| threshold |
| machine_learning_job_id |
| anomaly_threshold |
| new_terms_fields |
| history_window_start |
| type |
| Rule type | Field name in UI | Diffable rule field |
| ---------------- | ------------------------- | ------------------------- |
| All rule types | Rule name | `name` |
| All rule types | Rule description | `description` |
| All rule types | Tags | `tags` |
| All rule types | Default severity | `severity` |
| All rule types | Severity Override | `severity_mapping` |
| All rule types | Default risk score | `risk_score` |
| All rule types | Risk score override | `risk_score_mapping` |
| All rule types | Reference URLs | `references` |
| All rule types | False positive examples | `false_positives` |
| All rule types | MITRE ATT&CK™ threats | `threat` |
| All rule types | Setup guide | `setup` |
| All rule types | Investigation guide | `note` |
| All rule types | Related integrations | `related_integrations` |
| All rule types | Required fields | `required_fields` |
| All rule types | Rule schedule | `rule_schedule` |
| All rule types | Max alerts per run | `max_signals` |
| All rule types | Rule name override | `rule_name_override` |
| All rule types | Timestamp override | `timestamp_override` |
| All rule types | Timeline template | `timeline_template` |
| All rule types | Building block `*` | `building_block` |
| All rule types | Investigation fields | `investigation_fields` |
| All rule types | Data source `**` | `data_source` |
| All rule types | Suppress alerts | `alert_suppression` |
| Custom Query | Custom query | `kql_query` |
| Saved Query | Custom query | `kql_query` |
| EQL | EQL query | `eql_query` |
| ESQL | ESQL query | `esql_query` |
| Threat Match | Custom query | `kql_query` |
| Threat Match | Indicator index patterns | `threat_index` |
| Threat Match | Indicator index query | `threat_query` |
| Threat Match | Indicator mapping | `threat_mapping` |
| Threat Match | Indicator prefix override | `threat_indicator_path` |
| Threshold | Custom query | `kql_query` |
| Threshold | Threshold config | `threshold` |
| Machine Learning | Machine Learning job | `machine_learning_job_id` |
| Machine Learning | Anomaly score threshold | `anomaly_threshold` |
| New Terms | Custom query | `kql_query` |
| New Terms | Fields | `new_terms_fields` |
| New Terms | History Window Size | `history_window_start` |

- `*` Building block field is used to mark alerts as building block alerts.
- `**` Data Source represents index patterns or a data view. Machine Learning rules don't have data_source field.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

These are fields in the detection rule schema that cannot be customized for a prebuilt rule.

| version |
| id |
| author |
| license |
| Field name | Diffable rule field |
| ------------ | ------------------- |
| Rule type | `type` |
| Rule version | `version` |
| Rule author | `author` |
| Rule license | `license` |
Loading

0 comments on commit 273f2c1

Please sign in to comment.