-
Notifications
You must be signed in to change notification settings - Fork 201
[ESS][8.18] Updating customized prebuilt rules #6568
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
50 commits
Select commit
Hold shift + click to select a range
c915e1f
First draft
nastasha-solomon be17ff8
More edits
nastasha-solomon be84c25
Added statuses table
nastasha-solomon 51d6920
Revisions to update section
nastasha-solomon 39c6044
Merge branch '8.x' into issue-5061-update
nastasha-solomon c62ddba
Refreshed screenshot
nastasha-solomon 9925ac6
Change image size
nastasha-solomon 49b65b7
Merge branch '8.x' into issue-5061-update
nastasha-solomon 0248aa8
rewords a few sentences
nastasha-solomon 6f5e33d
final edits
nastasha-solomon e93e3a3
remove s
nastasha-solomon 07bc284
updates to statuses
nastasha-solomon b5b5fc4
Address feedback
nastasha-solomon fa75772
Fix headings
nastasha-solomon 20461fc
Update image name
nastasha-solomon 76fe435
update other image name
nastasha-solomon 8a7b6d7
Merge branch '8.x' into issue-5061-update
nastasha-solomon 4563e6e
Re-adds notes
nastasha-solomon 05e9963
Missing details
nastasha-solomon bfc297c
Typos
nastasha-solomon df691b7
Adds term definitions
nastasha-solomon 4fb177d
form match
nastasha-solomon 92e719e
More edits
nastasha-solomon fe9ce3d
the ref isn't reffing
nastasha-solomon d80cb6c
Update docs/detections/prebuilt-rules-management.asciidoc
nastasha-solomon 33e4554
Updates image
nastasha-solomon 1b0fe80
Nikita's feedback
nastasha-solomon f15763d
Merge branch '8.x' into issue-5061-update
nastasha-solomon 5f7647d
Merge branch '8.x' into issue-5061-update
nastasha-solomon e35b418
Update docs/detections/prebuilt-rules-management.asciidoc
nastasha-solomon d7c6d02
Merge branch '8.x' into issue-5061-update
nastasha-solomon 7f9c482
Update docs/detections/prebuilt-rules-update-modified-unmodified.asci…
nastasha-solomon 47ae05f
Merge branch '8.x' into issue-5061-update
nastasha-solomon a503d53
Davis' feedback
nastasha-solomon e509ab7
Merge branch '8.x' into issue-5061-update
nastasha-solomon 5b682ed
Update docs/detections/prebuilt-rules-update-modified-unmodified.asci…
nastasha-solomon fd7b697
Update docs/detections/prebuilt-rules-management.asciidoc
nastasha-solomon c80ed84
Remove outdated text
nastasha-solomon 446f504
Georgii's feedback
nastasha-solomon ee0f6f0
Merge branch '8.x' into issue-5061-update
nastasha-solomon cce052b
Merge branch '8.x' into issue-5061-update
nastasha-solomon 1184852
Minor editorial fixes (word choice and grammar)
nastasha-solomon e62118c
Merge branch 'issue-5061-update' of github.com:elastic/security-docs …
nastasha-solomon 090d1df
Merge branch '8.x' into issue-5061-update
nastasha-solomon b7c1708
Merge branch '8.x' into issue-5061-update
nastasha-solomon 02756f0
Update docs/detections/prebuilt-rules-management.asciidoc
nastasha-solomon 2bd30b5
column headings
nastasha-solomon 0b6faab
table syntax
nastasha-solomon 817895a
spacing or newlines?
nastasha-solomon c852c32
this table is cursed
nastasha-solomon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
docs/detections/prebuilt-rules-update-modified-unmodified.asciidoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
[[prebuilt-rules-update-modified-unmodified]] | ||
== Update modified and unmodified Elastic prebuilt rules | ||
|
||
.Requirements | ||
[sidebar] | ||
-- | ||
You must have an https://www.elastic.co/subscriptions/cloud[Enterprise] subscription to access this feature. If you have a Platinum subscription or lower, follow the guidelines in <<update-prebuilt-rules>> instead. | ||
-- | ||
|
||
This page provides instructions for updating modified and unmodified prebuilt rules. You can also find information about <<rule-field-update-statuses,statuses>> or <<resolve-reduce-rule-conflicts,conflicts>> that you might encounter when updating rules. | ||
|
||
To update rules: | ||
|
||
. Find *Detection rules (SIEM)* in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. | ||
. In the *Rules* table, select the *Rule Updates* tab. | ||
+ | ||
NOTE: The *Rule Updates* tab doesn't appear if all your installed prebuilt rules are up to date. | ||
+ | ||
[role="screenshot"] | ||
image::images/prebuilt-rules-update-advanced.png[The Rule Updates tab on the Rules page] | ||
|
||
. (Optional) To examine the details of a rule's latest version before you update it, select the rule name. This opens the rule update flyout, where you can: | ||
|
||
** Preview incoming updates: Select the *Elastic update overview* tab to view rule changes field by field, or the *JSON view* tab to view changes for the entire rule in JSON format. | ||
|
||
** Compare different versions of a rule field: Use the **Diff view** drop-down menu to compare different versions of a rule field. For example, compare the changes that you made to the current version of the field with changes that will be applied from the incoming Elastic update. | ||
+ | ||
NOTE: If you haven't updated the rule in a while, its original version might be unavailable for comparison. Instead, you will only have access to the rule's current version and the incoming Elastic update. You can avoid this by updating prebuilt rules more often. | ||
|
||
** Check the update status: View the status of the entire rule update and for <<rule-field-update-statuses,each field that's being changed>>. | ||
|
||
** Address update conflicts: Find and address conflicts that <<resolve-reduce-rule-conflicts, need additional attention>>. | ||
|
||
** Edit the final update: Change the update that will be applied to the field when you update the rule. To change the update, go to the *Final update* section, make your changes, and then save them. | ||
+ | ||
IMPORTANT: Elastic updates containing a rule type change cannot be edited. Before updating the rule, duplicate it if you need to record changes that you made to the rule fields. | ||
+ | ||
[role="screenshot"] | ||
image::images/prebuilt-rules-update-diff-advanced.png[Prebuilt rule comparison,85%] | ||
+ | ||
|
||
. From the *Rule Updates* tab, do one of the following to update prebuilt rules: | ||
+ | ||
* Update all available rules: Click *Update all*. If any rules have conflicts, you will be prompted to take <<resolve-reduce-rule-conflicts,additional action>>. | ||
* Update a single rule without conflicts: Click *Update rule* for that rule. | ||
* Update multiple rules: Select the rules and click *Update _x_ selected rule(s)*. If any rules have conflicts, you will be prompted to take additional action. | ||
+ | ||
[TIP] | ||
==== | ||
|
||
To find specific rules to update: | ||
|
||
* Use the **Modified/Unmodified** drop-down menu to only display modified or unmodified prebuilt rules. | ||
* Use the search bar and *Tags* filter to find the rules you want to update. For example, filter by `OS: Windows` if your environment only includes Windows endpoints. For more on tag categories, refer to <<prebuilt-rule-tags>>. | ||
|
||
==== | ||
|
||
[float] | ||
[[rule-field-update-statuses]] | ||
=== Understand rule field update statuses | ||
|
||
This table describes statuses that might appear for rule fields being updated. | ||
|
||
[width="100%",cols="2",options="header"] | ||
|============================================== | ||
|Status |Description | ||
|
||
|*Ready for update* a|Displays when there are no conflicts to resolve. | ||
|
||
Further action is not required for the field. It is ready to be updated. | ||
|
||
|*No update* a|Displays when the field is not being updated by Elastic, but the current field value differs from the original one. This typically happens when the field's value was changed after the prebuilt rule was initially installed. | ||
|
||
Further action is not required for the field. It is ready to be updated. | ||
|
||
TIP: You can still change the final field update, if needed. To do so, make your changes in the *Final update* section and save them. | ||
|
||
|*Review required* a|Displays when Elastic auto-resolves a conflict between the current field value and the value from the incoming Elastic update. | ||
|
||
You must accept or edit the field's final update and save the changes. Refer to <<resolve-reduce-rule-conflicts>> to learn more about auto-resolved conflicts and how to reduce future conflicts. | ||
|
||
|*Action required* a|Displays when Elastic could not auto-resolve the conflict between the current field value and the value from the incoming Elastic update. | ||
|
||
You must manually set and save the field's final update. Refer to <<resolve-reduce-rule-conflicts>> to learn more about conflicts that need manual fixes and how to reduce future conflicts. | ||
|
||
|============================================== | ||
|
||
|
||
[float] | ||
[[resolve-reduce-rule-conflicts]] | ||
=== Resolve and reduce update conflicts | ||
|
||
Keeping prebuilt rules up to date might help you minimize the frequency and complexity of conflicts that occur during rule updates. | ||
|
||
When a conflict does happen, Elastic attempts to resolve it and will suggest a fix for your review. This is called an _auto-resolved conflict_. You can still update rules with auto-resolved conflicts, but we advise against bulk-updating multiple rules as it's risky and can sometimes lead to lost rule modifications and other issues. Instead, we recommend carefully reviewing each rule with auto-resolved conflicts from the rule update flyout. | ||
|
||
If Elastic can't resolve a conflict, you must manually fix it before updating the rule. This is called an _unresolved conflict_. To fix unresolved conflicts in a rule, do the following: | ||
|
||
. From the **Rule update** tab, click on the rule name or click **Review**. This opens the rule update flyout, where you can find rule fields with unresolved conflicts. | ||
+ | ||
TIP: Fields with unresolved conflicts have the `Action required` status. | ||
|
||
. Go to the *Final update* section and do any of the following: | ||
** Keep the current value instead of accepting the Elastic update. | ||
** Accept the Elastic update and overwrite the current value. | ||
** Edit the final field value by combining the current value with the Elastic update or making the appropriate changes. | ||
. Click **Save and accept** to apply your changes. The field's status changes to `Ready for update`. | ||
|
||
After you've resolved the remaining conflicts, click *Update rule* to accept the changes and install the updated version. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.