Skip to content

Conversation

@benironside
Copy link
Contributor

@benironside benironside commented Jun 22, 2022

Resolves #2044 by creating a page with instructions for enabling CSPM / KSPM.

Preview

@tinnytintin10 tinnytintin10 self-requested a review June 22, 2022 19:45
@benironside benironside mentioned this pull request Jun 23, 2022
15 tasks
@cla-checker-service
Copy link

cla-checker-service bot commented Jun 24, 2022

💚 CLA has been signed

@tinnytintin10
Copy link
Contributor

@benironside I just updated some things, please take a look and lmk what you think. Feel free to reword/restructure some of the things I added.

I will review again when you're ready to merge to master 🙌🏾

@benironside
Copy link
Contributor Author

[elasticmachine run elasticsearch-ci/docs rebuild

@benironside benironside marked this pull request as ready for review June 24, 2022 16:21
@benironside
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs rebuild

benironside and others added 7 commits June 24, 2022 09:41
)

* Remove workaround from create rule docs

* Restore admonition, with revisions from Madison
…ty" screenshots (#2075)

* Updates screenshots and replaces the old name with the new name.

* Updates text, fixes image names

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Fix bugs found by QA

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
* Update eql-rule-query-example.png

* Update procedure for creating EQL rule

* Update API docs: create rule, update rule

* Align minor phrasing

* Explain timestamp_field & timestamp_override

* Updates based on review feedback
* Move callout about endpoint exceptions to more appropriate section

This not was previously at the top-level exceptions section, when it
really only applies when adding to the Endpoint rule.

* Add note about mappings being required for exceptions

Wording is subject to change; just throwing something at the wall for
now.

* Apply suggestions from code review

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

Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
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.

Great, clean approach to a big new feature! I added a mix of suggestions on line-edits and macro formatting, thanks!

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.

@benironside left some comments for your review. Your images appear to be "floating" - I would wrap a 1-2px dark border around each of them to give them some definition.

image::images/kspm-1.png[The Manage deployment button]

1. Under `My deployment`, select **Kibana**.
2. Under "Instances", click the three-dot menu next to your instance, then click **Edit configuration**.
Copy link
Contributor

Choose a reason for hiding this comment

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

@joepeeples correct me if it should be quotes instead of bold -- can't remember what we've done traditionally.

Suggested change
2. Under "Instances", click the three-dot menu next to your instance, then click **Edit configuration**.
2. Under **Instances**, click the three-dot menu next to your instance, then click **Edit configuration**.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

going with bold for now

benironside and others added 11 commits June 24, 2022 13:30
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
Copy link
Contributor

@tinnytintin10 tinnytintin10 left a comment

Choose a reason for hiding this comment

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

LGTM

@benironside benironside added the readyforQA PRs that are ready for QA review. label Jun 24, 2022
@benironside benironside merged commit edeecb9 into main Jun 28, 2022
mergify bot pushed a commit that referenced this pull request Jun 28, 2022
* First draft

* Add placeholder for instructions for self-hosted

* updates formatting

* updates format and image size

* Updates formatting and annotates screenshots

* updates to the main intro and some terms here and there

* [DOCS] Revise workaround for aggregated fields in threshold rules (#2074)

* Remove workaround from create rule docs

* Restore admonition, with revisions from Madison

* [DOCS][8.3] Updates "Endpoint Security" to "Endpoint and Cloud Security" screenshots (#2075)

* Updates screenshots and replaces the old name with the new name.

* Updates text, fixes image names

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Fix bugs found by QA

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Add example response section (#2084)

* [DOCS] Add new EQL search configuration options (#2061)

* Update eql-rule-query-example.png

* Update procedure for creating EQL rule

* Update API docs: create rule, update rule

* Align minor phrasing

* Explain timestamp_field & timestamp_override

* Updates based on review feedback

* [DOCS] Adds warning about exceptions requiring mappings (#2110)

* Move callout about endpoint exceptions to more appropriate section

This not was previously at the top-level exceptions section, when it
really only applies when adding to the Endpoint rule.

* Add note about mappings being required for exceptions

Wording is subject to change; just throwing something at the wall for
now.

* Apply suggestions from code review

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

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

* [DOCS] Removed ref to Stack GS (#2128)

* Minor edits to Tin's work

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Matches order of sections to order they're mentioned in the intro

* Changes bullets to numbers

* Update docs/experimental-features/experimental-features-intro.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/experimental-features-intro.asciidoc

* Incorporate Joe's and Janeen's feedback

* fixes build error

* troubleshoots build error

* troubleshoots build error

* troubleshoots build erors

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit edeecb9)
benironside added a commit that referenced this pull request Jun 28, 2022
* First draft

* Add placeholder for instructions for self-hosted

* updates formatting

* updates format and image size

* Updates formatting and annotates screenshots

* updates to the main intro and some terms here and there

* [DOCS] Revise workaround for aggregated fields in threshold rules (#2074)

* Remove workaround from create rule docs

* Restore admonition, with revisions from Madison

* [DOCS][8.3] Updates "Endpoint Security" to "Endpoint and Cloud Security" screenshots (#2075)

* Updates screenshots and replaces the old name with the new name.

* Updates text, fixes image names

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/getting-started/install-endpoint.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Fix bugs found by QA

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Add example response section (#2084)

* [DOCS] Add new EQL search configuration options (#2061)

* Update eql-rule-query-example.png

* Update procedure for creating EQL rule

* Update API docs: create rule, update rule

* Align minor phrasing

* Explain timestamp_field & timestamp_override

* Updates based on review feedback

* [DOCS] Adds warning about exceptions requiring mappings (#2110)

* Move callout about endpoint exceptions to more appropriate section

This not was previously at the top-level exceptions section, when it
really only applies when adding to the Endpoint rule.

* Add note about mappings being required for exceptions

Wording is subject to change; just throwing something at the wall for
now.

* Apply suggestions from code review

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

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

* [DOCS] Removed ref to Stack GS (#2128)

* Minor edits to Tin's work

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Matches order of sections to order they're mentioned in the intro

* Changes bullets to numbers

* Update docs/experimental-features/experimental-features-intro.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/security-posture-management.asciidoc

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

* Update docs/experimental-features/experimental-features-intro.asciidoc

* Incorporate Joe's and Janeen's feedback

* fixes build error

* troubleshoots build error

* troubleshoots build error

* troubleshoots build erors

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
(cherry picked from commit edeecb9)

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

readyforQA PRs that are ready for QA review. v8.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Enable feature flag for KSPM

8 participants