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] Blocklist #1811

Merged
merged 21 commits into from
Apr 12, 2022
Merged

[DOCS] Blocklist #1811

merged 21 commits into from
Apr 12, 2022

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Apr 4, 2022

Resolves #1783.

Previews:

NOTE: We're trying to prioritize reviewing & merging this PR quickly, to resolve a docs link in elastic/kibana#128773 which is blocked until the new Blocklist page is live. If additional changes are needed closer to release, issue #1818 allows another opportunity.

@joepeeples joepeeples added Team: Docs Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management v8.2.0 labels Apr 4, 2022
@joepeeples joepeeples self-assigned this Apr 4, 2022
@joepeeples joepeeples mentioned this pull request Apr 6, 2022
3 tasks
@joepeeples joepeeples marked this pull request as ready for review April 6, 2022 20:54
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

New page! Great work! Left some suggestions for your consideration.

docs/getting-started/configure-integration-policy.asciidoc Outdated Show resolved Hide resolved
docs/getting-started/security-ui.asciidoc Outdated Show resolved Hide resolved

coming[8.2.0]

The blocklist allows you to prevent specified applications from running if you're certain they should never run in a host environment, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful to ensure that known malicious processes aren't accidentally executed by an end user.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The blocklist allows you to prevent specified applications from running if you're certain they should never run in a host environment, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful to ensure that known malicious processes aren't accidentally executed by an end user.
The blocklist allows you to prevent specified applications from running if you're certain they should never run in a host environment, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful for ensuring that known malicious processes aren't accidentally executed by end users.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if the last sentence (the one I made suggestions on) is necessary, I think folks are pretty clear on the value of blocklisting and it extends beyond adding guardrails for users/insiders.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I get what you mean, but I also like having a little extra explanation for the feature beyond the boilerplate description. @caitlinbetz, any thoughts? Or other use case info you think would be helpful here?

This combines @benironside's edits and other tweaks for consistency with similar wording:

Suggested change
The blocklist allows you to prevent specified applications from running if you're certain they should never run in a host environment, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful to ensure that known malicious processes aren't accidentally executed by an end user.
The blocklist allows you to prevent specified applications from running on hosts, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful for ensuring that known malicious processes aren't accidentally executed by end users.

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

Left some minor suggestions. Overall, looks great!

docs/getting-started/configure-integration-policy.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/blocklist.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/blocklist.asciidoc Outdated Show resolved Hide resolved
joepeeples and others added 2 commits April 7, 2022 14:44
Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
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.

Just a few slight suggestions. Looks great!

docs/getting-started/configure-integration-policy.asciidoc Outdated Show resolved Hide resolved
Comment on lines +11 to +13
In addition to configuring specific entries on the **Blocklist** page, you must also ensure that the blocklist is enabled on the {endpoint-sec} integration policy in the <<malware-protection, Malware protection settings>>. This setting is enabled by default.

You must have the built-in `superuser` role to access the blocklist. For more information, refer to {ref}/built-in-users.html[Built-in users].
Copy link
Contributor

Choose a reason for hiding this comment

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

We talked about the possibility of putting the "block box" (can't think of the official term). Here's the syntax again just in case you want to try it.

.Title
*****
Text text 

* Bullet
* Bullet

Text text text 

*****

Copy link
Contributor Author

@joepeeples joepeeples Apr 11, 2022

Choose a reason for hiding this comment

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

Since most of the pages for endpoint management are so similar, I'd like to make this update in a separate issue that includes adding the prerequisites box consistently across all the pages. I was already thinking of creating this issue for general consistency fixes, so I think the prereqs box would fall nicely into that issue's scope.

docs/management/admin/blocklist.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/blocklist.asciidoc Outdated Show resolved Hide resolved
docs/management/admin/blocklist.asciidoc Outdated Show resolved Hide resolved
joepeeples and others added 2 commits April 11, 2022 13:17
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
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.

Left one comment, otherwise - looks good to me!

Co-authored-by: Kevin Logan <56395104+kevinlog@users.noreply.github.com>
@joepeeples joepeeples merged commit 89b1455 into main Apr 12, 2022
mergify bot pushed a commit that referenced this pull request Apr 12, 2022
* Create new Blocklist page

* Add Blocklist page to TOC

* Add new Blocklist section on UI overview page for

* Correction

* Align description on UI overview page

* Update config integration policy page, image

* Add info about int policy to blocklist page

* Add Blocklist to UI list

* Adds prelim "coming" tag, some corrections

* Correction

* Add info about multiple values, lists

* another. correction.

* Apply first round of feedback

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Apply a few more feedback edits

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>

* Update docs/management/admin/blocklist.asciidoc

* Update docs/management/admin/blocklist.asciidoc

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>

* Rename actions menu (prev button)

* Update docs/management/admin/blocklist.asciidoc

* Update docs/getting-started/configure-integration-policy.asciidoc

Co-authored-by: Kevin Logan <56395104+kevinlog@users.noreply.github.com>

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Kevin Logan <56395104+kevinlog@users.noreply.github.com>
(cherry picked from commit 89b1455)
joepeeples added a commit that referenced this pull request Apr 12, 2022
* Create new Blocklist page

* Add Blocklist page to TOC

* Add new Blocklist section on UI overview page for

* Correction

* Align description on UI overview page

* Update config integration policy page, image

* Add info about int policy to blocklist page

* Add Blocklist to UI list

* Adds prelim "coming" tag, some corrections

* Correction

* Add info about multiple values, lists

* another. correction.

* Apply first round of feedback

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Apply a few more feedback edits

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>

* Update docs/management/admin/blocklist.asciidoc

* Update docs/management/admin/blocklist.asciidoc

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>

* Rename actions menu (prev button)

* Update docs/management/admin/blocklist.asciidoc

* Update docs/getting-started/configure-integration-policy.asciidoc

Co-authored-by: Kevin Logan <56395104+kevinlog@users.noreply.github.com>

Co-authored-by: benironside <91905639+benironside@users.noreply.github.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Kevin Logan <56395104+kevinlog@users.noreply.github.com>
(cherry picked from commit 89b1455)

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@joepeeples joepeeples deleted the issue-1783-blocklist branch April 12, 2022 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team: Docs Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Blocklist
6 participants