-
Notifications
You must be signed in to change notification settings - Fork 181
[9.0 & Serverless] Updating customized prebuilt rules #904
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 15 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
a08b0de
First draft
nastasha-solomon ace15b2
lot's and lot's of changes
nastasha-solomon 0c1c021
toc
nastasha-solomon 915470a
Image ref
nastasha-solomon f728a1e
Merge branch 'main' into issue-5061-update-9.0-serv
nastasha-solomon 3ac8dd9
image refresh
nastasha-solomon c322c9b
Merge branch 'issue-5061-update-9.0-serv' of https://github.com/elast…
nastasha-solomon 72bd784
Added serverless subscription details
nastasha-solomon 5311089
cleanup
nastasha-solomon 1b5d8f9
adds missing word
nastasha-solomon 28a198a
formatting
nastasha-solomon f671327
Merge branch 'main' into issue-5061-update-9.0-serv
nastasha-solomon 924e7d7
Update solutions/security/detect-and-alert/prebuilt-rules-update-modi…
nastasha-solomon 97d6ef8
Column headings
nastasha-solomon 3edbe89
Merge branch 'main' into issue-5061-update-9.0-serv
nastasha-solomon f2c8693
Update solutions/security/detect-and-alert/prebuilt-rules-update-modi…
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
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
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
110 changes: 110 additions & 0 deletions
110
solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md
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,110 @@ | ||
| --- | ||
| applies_to: | ||
| stack: all | ||
| serverless: | ||
| security: all | ||
| --- | ||
|
|
||
| # Update modified and unmodified Elastic prebuilt rules [prebuilt-rules-update-modified-unmodified] | ||
|
|
||
| ::::{admonition} Requirements | ||
|
|
||
| You must have an [Enterprise subscription](https://www.elastic.co/pricing) on {{stack}} or a [Complete project tier subscription](../../../deploy-manage/deploy/elastic-cloud/project-settings.md) on {{serverless-short}} to access this feature. | ||
|
|
||
| If you have a Platinum subscription or lower on {{stack}} or an Essentials project tier subscription on {{serverless-short}}, follow the guidelines in [Update Elastic prebuilt rules](/solutions/security/detect-and-alert/install-manage-elastic-prebuilt-rules.md#update-prebuilt-rules) instead. | ||
|
|
||
| :::: | ||
|
|
||
| This page provides instructions for updating modified and unmodified prebuilt rules. You can also find information about [statuses](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#rule-field-update-statuses) or [conflicts](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#resolve-reduce-rule-conflicts) that you might encounter when updating rules. | ||
|
|
||
| To update rules: | ||
|
|
||
| 1. Find **Detection rules (SIEM)** in the navigation menu or by using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
| 2. 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. | ||
| :::: | ||
|
|
||
| :::{image} /solutions/images/security-prebuilt-rules-update-advanced.png | ||
| :alt: The Rule Updates tab on the Rules page | ||
| :screenshot: | ||
| ::: | ||
|
|
||
| 3. (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 [each field that's being changed](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#rule-field-update-statuses). | ||
|
|
||
| * Address update conflicts: Find and address conflicts that [need additional attention](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#resolve-reduce-rule-conflicts). | ||
|
|
||
| * 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. | ||
| :::: | ||
|
|
||
| :::{image} /solutions/images/security-prebuilt-rules-update-diff-advanced.png | ||
| :alt: Prebuilt rule comparison | ||
| :screenshot: | ||
| ::: | ||
|
|
||
|
|
||
| 4. 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 [additional attention](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#resolve-reduce-rule-conflicts). | ||
| * 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](/solutions/security/detect-and-alert/install-manage-elastic-prebuilt-rules.md#prebuilt-rule-tags). | ||
|
|
||
| :::: | ||
|
|
||
| ## Understand rule field update statuses [rule-field-update-statuses] | ||
|
|
||
| This table describes statuses that might appear for rule fields being updated. | ||
|
|
||
| | Status | Description | | ||
| | --- | --- | | ||
| | **Ready for update** | Displays when there are no conflicts to resolve.<br><br>Further action is not required for the field. It is ready to be updated.<br> | | ||
| | **No update** | 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.<br><br>Further action is not required for the field. It is ready to be updated.<br><br> **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.<br><br> | | ||
| | **Review required** | Displays when Elastic auto-resolves a conflict between the current field value and the value from the incoming Elastic update.<br><br>You must accept or edit the field's final update and save the changes. Refer to [Resolve and reduce update conflicts](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#resolve-reduce-rule-conflicts) to learn more about auto-resolved conflicts and how to reduce future conflicts.<br> | | ||
| | **Action required** | Displays when Elastic could not auto-resolve the conflict between the current field value and the value from the incoming Elastic update.<br><br>You must manually set and save the field's final update. Refer to Refer to [Resolve and reduce update conflicts](/solutions/security/detect-and-alert/prebuilt-rules-update-modified-unmodified.md#resolve-reduce-rule-conflicts) to learn more about conflicts that need manual fixes and how to reduce future conflicts.<br> | | ||
|
|
||
|
|
||
| ## Resolve and reduce update conflicts [resolve-reduce-rule-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: | ||
|
|
||
| 1. 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. | ||
| :::: | ||
|
|
||
| 2. 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. | ||
|
|
||
| 3. 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. | ||
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
Oops, something went wrong.
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.