Skip to content

Commit

Permalink
[DOCS][8.3] Create CSPM / KSPM page (#2089)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>

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

Co-authored-by: Joe Peeples <[email protected]>

* Fix bugs found by QA

Co-authored-by: Joe Peeples <[email protected]>

* 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 <[email protected]>

Co-authored-by: nastasha-solomon <[email protected]>

* [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 <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

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

Co-authored-by: nastasha-solomon <[email protected]>

* 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 <[email protected]>

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

Co-authored-by: Joe Peeples <[email protected]>

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

Co-authored-by: Joe Peeples <[email protected]>

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

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

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

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

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

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

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

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

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

Co-authored-by: Joe Peeples <[email protected]>

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

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

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

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

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

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

* 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 <[email protected]>
Co-authored-by: Ryland Herrick <[email protected]>
Co-authored-by: nastasha-solomon <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: Janeen Mikell-Straughn <[email protected]>
  • Loading branch information
6 people authored Jun 28, 2022
1 parent d032712 commit edeecb9
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
[[sec-experimental-intro]]
= Technical preview

The following features in this section are experimental and may be changed or removed completely in a future release. Elastic will make a best effort to fix any issues, but experimental features are not subject to the support of official GA features.
The features in this section are experimental and may be changed or removed completely in future releases. Elastic will make a best effort to fix any issues, but experimental features are not supported to the same level as generally available (GA) features.


include::host-risk-score.asciidoc[]
include::beaconing-detection.asciidoc[]
include::security-posture-management.asciidoc[]
Binary file added docs/experimental-features/images/kspm-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/experimental-features/images/kspm-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs/experimental-features/security-posture-management.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[[security-posture-management]]
== Cloud security posture management

NOTE: This feature requires {stack} version 8.3.0 or later.

Cloud security posture management (CSPM) and Kubernetes security posture management (KSPM) continuously monitor and compare your cloud and Kubernetes infrastructure against security best practices to help you identify and remediate misconfigurations.

The steps to enable this feature differ between {ecloud} and self-hosted deployments.

[[enable-kspm-on-cloud]]
[discrete]
=== Enable KSPM for cloud deployments

1. First, enable the KSPM flag for your deployment:

a. From {kib}, open the main menu and click **Manage this deployment**.
+
image::images/kspm-1.png[The Manage deployment button]

b. Under **My deployment**, select **{kib}**.
c. Under **Instances**, click the three-dot menu next to your instance, then click **Edit configuration**.
d. Click **Edit user settings** in the upper-right of the page.
e. Add `xpack.cloudSecurityPosture.enabled: true` to the user settings.
f. Click **Back**, then save your {kib} user settings.
+
NOTE: It may take up to two minutes for the changes to take effect.
+
2. Return to {kib}. From the main menu, go to **Security** -> **Cloud Security**.
+
image::images/kspm-2.png[The Cloud Security button on the main menu, width=160]
+
3. Follow the prompts to set up data ingestion.

[[enable-kspm-on-selfhosted]]
[discrete]
=== Enable KSPM for self-hosted deployments
1. Edit the `kibana.yml` file (typically found at `/config/kibana.yml`) to include `xpack.cloudSecurityPosture.enabled: true`.

2. Return to {kib}. From the main menu, go to **Security** -> **Cloud Security**.
+
image::images/kspm-2.png[The Cloud Security button on the main menu, width=160]

3. Follow the prompts to set up data ingestion.

0 comments on commit edeecb9

Please sign in to comment.