Skip to content
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

New endpoint rules #6100

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Conversation

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@natasha-moore-elastic
Copy link
Contributor Author

run docs-build

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some edits that apply to ESS and Serverless docs, and a few questions. Thanks for putting these docs together, @natasha-moore-elastic!

docs/detections/detection-engine-intro.asciidoc Outdated Show resolved Hide resolved
docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/serverless/rules/detection-engine-overview.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent content, both new and updated! Added some comments in dialogue with @nastasha-solomon's review to tighten up language.

docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
== Feature-specific protection rules

The following endpoint protection rules give you more granular control over how you handle the generated alerts. These rules are tailored for each of {elastic-defend}'s endpoint protection features—malware, ransomware, memory threats, and malicious behavior. Enabling these rules allows you to configure more specific actions based on the protection feature and whether the malicious activity was prevented or detected.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the following rules need to reference prebuilt rule docs?

Probably eventually, though we might be able to publish an MVP of this page without linking to prebuilt rule docs for now. Getting those prebuilt rule docs might be out of scope for this, and something that TRADE team handles?

docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/detection-engine-intro.asciidoc Outdated Show resolved Hide resolved
docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/serverless/rules/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/endpoint-protection-rules.asciidoc Outdated Show resolved Hide resolved
== Feature-specific protection rules

The following endpoint protection rules give you more granular control over how you handle the generated alerts. These rules are tailored for each of {elastic-defend}'s endpoint protection features—malware, ransomware, memory threats, and malicious behavior. Enabling these rules allows you to configure more specific actions based on the protection feature and whether the malicious activity was prevented or detected.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add the links after the rules are published. The docs creation for prebuilt rules is managed by TRADE and those will be added automatically during the rules release process. I think linking them would be helpful.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - good job with these docs!

@acorretti acorretti force-pushed the issue-5993-endpoint-rules branch from 22760ce to 79fcc7a Compare November 19, 2024 18:23
@acorretti acorretti self-requested a review as a code owner November 19, 2024 18:23
Copy link
Contributor

mergify bot commented Nov 19, 2024

This pull request is now in conflicts. Could you fix it @natasha-moore-elastic? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-5993-endpoint-rules upstream/issue-5993-endpoint-rules
git merge upstream/main
git push upstream issue-5993-endpoint-rules

@acorretti acorretti removed their request for review November 19, 2024 18:55
@caitlinbetz
Copy link

Thanks @natasha-moore-elastic! I think the new endpoint rules page will be helpful to have.

One bit of feedback - I think it could be helpful to indicate/clarify somewhere (at the beginning of the "Feature-specific protection rules" section, maybe?) that they can choose to use the "Endpoint Security rule" OR the feature-specific protection rules instead. Using both will result in duplicate alerts.

So perhaps emphasis that Endpoint Security rule is automatically enabled out of the box with the installation of Elastic Defend and that no other action is required. However, they can opt-in to using the 8 granular rules if they desire. If they do this, we recommend using those instead of the Endpoint Security rule (disabling "Endpoint Security")

Also I believe we held off on the changing the name of the main rule from "Endpoint Security" to "Elastic Defend" (So for now it is still "Endpoint Security", cc @approksiu )

approksiu
approksiu previously approved these changes Nov 21, 2024
Copy link
Contributor

@approksiu approksiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, left a minor comment. This can be merged around the time these rules are shipped to the users - to be coordinated with TRADE team.

docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
@natasha-moore-elastic
Copy link
Contributor Author

Looks good, left a minor comment. This can be merged around the time these rules are shipped to the users - to be coordinated with TRADE team.

Thanks @approksiu! Please do keep us in the loop on the timeline for merging these docs.

caitlinbetz
caitlinbetz previously approved these changes Dec 3, 2024
Copy link
Contributor

mergify bot commented Dec 4, 2024

This pull request is now in conflicts. Could you fix it @natasha-moore-elastic? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-5993-endpoint-rules upstream/issue-5993-endpoint-rules
git merge upstream/main
git push upstream issue-5993-endpoint-rules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request] 8 New Endpoint Security rules
5 participants