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

[DOCS] Endpoint artifact docs clarification #2516

Merged
merged 24 commits into from
Oct 18, 2022
Merged

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Sep 28, 2022

Resolves #2111: "Expand the existing Trusted Apps/Exceptions/Blocklist etc pages to add more specifics on their use cases and how they differ."

Note that the new page "Optimize Elastic Defend" also serves as the landing page for docs links in the UI, such as elastic/kibana#142467.

Previews:

- Create new page
- Add new page to the "Endpoint management" TOC
@joepeeples joepeeples added Team: Docs Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management Feature: Onboarding Any issues related to onboarding our customers edit Docs that need minor updates or revisions. v8.5.0 labels Sep 28, 2022
@joepeeples joepeeples self-assigned this Sep 28, 2022
@github-actions
Copy link

Documentation previews:

@mergify

This comment was marked as resolved.

@joepeeples joepeeples marked this pull request as ready for review October 3, 2022 20:07
Copy link
Contributor

@kevinlog kevinlog left a comment

Choose a reason for hiding this comment

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

LGTM, I like the format for everything.

Copy link
Collaborator

@ferullo ferullo left a comment

Choose a reason for hiding this comment

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

Looks great. Just one comment.

docs/management/admin/event-filters.asciidoc Outdated Show resolved Hide resolved
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.

Hopefully the feedback I left was helpful. This was as huge undertaking, good job!

The blocklist allows you to prevent specified applications from running on hosts, extending the list of processes that {elastic-defend} considers malicious. This is especially useful for ensuring that known malicious processes aren't accidentally executed by end users.
The blocklist allows you to prevent specified applications from running on hosts, extending the list of processes that {elastic-defend} considers malicious. This helps ensure that known malicious processes aren't accidentally executed by end users.

The blocklist is not intended to generically block applications assumed to be benign. To compare the blocklist with other endpoint artifacts, refer to <<endpoint-artifacts>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

What if you approached this from a different angle, for ex:

Suggested change
The blocklist is not intended to generically block applications assumed to be benign. To compare the blocklist with other endpoint artifacts, refer to <<endpoint-artifacts>>.
The blocklist fulfills the specific goal of blocking potentially harmful applications. Do not use it to broadly block non-permitted applications. To compare the blocklist with other endpoint artifacts, refer to <<endpoint-artifacts>>.

This is a lil wordy, but maybe that's needed to fully explain how users should and should not be using the blocklist.

NOT intended to generically block applications assumed to be benign.

| <<endpoint-rule-exceptions,Endpoint alert exception>>
a| *_Prevents {elastic-endpoint} from generating alerts or stopping processes._* Use to reduce false positive alerts or preventions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ignorant question here: what do you mean by "preventions"? If this is a common security term, ignore me. I've just never seen/heard the word used as a noun in this way. I've mainly seen it used a verb -- e.g., this feature prevents attacks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nastasha-solomon Here it's being used to refer to specific features of Elastic Defend, when the admin selects the "Prevent" option to have Elastic Defend/Endpoint stop certain processes. But I can see how that's not super clear; I'll tinker with this to be more specific.

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok, I didn't know we were referring to this feature as "preventions". Thanks for the clarification!

* Does not monitor the application for threats, and does not create alerts for the application, even if it behaves like malware, ransomware, etc.
* Does not generate events for the application except process events for visualizations.
* May improve performance, since {elastic-endpoint} monitors fewer processes.
* May still generate malicious behavior alerts, if the application's process events indicate malicious behavior.
Copy link
Contributor

@nastasha-solomon nastasha-solomon Oct 12, 2022

Choose a reason for hiding this comment

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

Do you think explaining what generates malicious behavior alerts and then contrasting that with what triggers other Elastic defend protection features (malware, ransomware, or memory threat protections, etc.) would help? Maybe something like:

Suggested change
* May still generate malicious behavior alerts, if the application's process events indicate malicious behavior.
* May still generate malicious behavior alerts, which are produced certain data patterns are noticed. The conditions the produce these alerts are different from those that other Elastic defend protection features (malware, ransomware, or memory threat protections, etc.) follow. <Brief explanation>

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Good discussions in the comments! Would like to take one more quick glance once feedback/comments are addressed. Overall, I think this will really help our customers.

docs/management/admin/blocklist.asciidoc Show resolved Hide resolved
docs/management/admin/endpoint-artifacts.asciidoc Outdated Show resolved Hide resolved
@joepeeples joepeeples requested a review from jmikell821 October 17, 2022 20:16
@joepeeples joepeeples added the readyforQA PRs that are ready for QA review. label Oct 17, 2022
@muskangulati-qasource
Copy link

Hi @joepeeples,

We have tested this PR for the reference docs attached in comparison to the latest 8.5.0 BC build received and below our observations for the same:

Issue reported:

We will test this PR once again after the related bug is closed.

Thank you!!

Copy link
Contributor

@jmikell821 jmikell821 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, thanks! One small nit for us all to keep in mind for the future is may vs might. MS Style recommends may to convey permission, and might to convey possibility. I naturally write may first - so just a thought 😉

@joepeeples
Copy link
Contributor Author

Looks good, thanks! One small nit for us all to keep in mind for the future is may vs might. MS Style recommends may to convey permission, and might to convey possibility. I naturally write may first - so just a thought 😉

Excellent point, thanks! I think I often naturally go with "may" too, but I like the preciseness of this distinction. Just revised the "mays" to "mights" here

@joepeeples
Copy link
Contributor Author

joepeeples commented Oct 18, 2022

@joepeeples joepeeples merged commit 59c53a0 into main Oct 18, 2022
mergify bot pushed a commit that referenced this pull request Oct 18, 2022
* First draft

- Create new page
- Add new page to the "Endpoint management" TOC

* Rename file/URL

* Enhance individual artifact descriptions

* Add xrefs from individual pages

* Revise tip about endpoint network events

* Initial suggestions from Ben's review

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>

* Singular/plural agreement

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>

* Apply suggestions from code review

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell-Straughn <[email protected]>

* Additional edits, fixes

* Explain preventions

* may --> might

* Update trusted apps screenshot

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: Janeen Mikell-Straughn <[email protected]>
(cherry picked from commit 59c53a0)
@joepeeples joepeeples deleted the 2111-endpoint-artifacts branch October 18, 2022 23:06
joepeeples added a commit that referenced this pull request Oct 18, 2022
* First draft

- Create new page
- Add new page to the "Endpoint management" TOC

* Rename file/URL

* Enhance individual artifact descriptions

* Add xrefs from individual pages

* Revise tip about endpoint network events

* Initial suggestions from Ben's review

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>

* Singular/plural agreement

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>

* Apply suggestions from code review

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell-Straughn <[email protected]>

* Additional edits, fixes

* Explain preventions

* may --> might

* Update trusted apps screenshot

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: Janeen Mikell-Straughn <[email protected]>
(cherry picked from commit 59c53a0)

Co-authored-by: Joe Peeples <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
edit Docs that need minor updates or revisions. Feature: Onboarding Any issues related to onboarding our customers readyforQA PRs that are ready for QA review. Team: Docs Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management v8.5.0
Projects
None yet
9 participants