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

Creates CSPM privileges standalone page #6269

Merged
merged 5 commits into from
Dec 13, 2024

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Dec 3, 2024

Fixes #6261 — Creates a standalone page that describes the privileges that grant different levels of access to CSPM features. Removes the lists of privileges from the requirements sections of each of the CSPM get started guides for AWS, GCP, and Azure, and replaces them with a link to the new page, which includes more details.

Preview: CSPM privilege requirements ESS, Serverless

@benironside benironside self-assigned this Dec 3, 2024
@benironside benironside requested a review from a team as a code owner December 3, 2024 23:14
Copy link

github-actions bot commented Dec 3, 2024

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.

opauloh
opauloh previously approved these changes Dec 4, 2024
Copy link

@opauloh opauloh left a comment

Choose a reason for hiding this comment

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

Great documentation, thank you @benironside 💯

Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

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

Nice work consolidating all privilege requirements into a single page! Some thoughts about the way the information is presented:

I feel that the current page layout answers the question “What does the read/write/manage privilege allow users to do?” but it could be more helpful to reframe the information so that it answers the question “For each specific action (e.g. enable or disable benchmark rules), what are the minimum privileges a user needs?” On the requirements pages for other features (e.g. Detections requirements or Cases requirements), we do that by using the tabular layout with “Action” as the first column. This focuses more on the different user actions and provides the minimum privileges for each of those actions. I think following the same convention and layout on this page would make the information easier to find and give users a more consistent docs experience.

@@ -0,0 +1,61 @@
[[cspm-required-permissions]]
= CSPM privilege requirements
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
= CSPM privilege requirements
= CSPM requirements

Just for consistency with other requirements pages

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page is focused only on privileges. Other requirements are listed in the getting started guides

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
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! If you choose to revisit the content's format, 1+ to @natasha-moore-elastic's suggestion for presenting the information in a table format and with summarized action descriptions.

benironside and others added 2 commits December 12, 2024 11:20
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
@benironside benironside merged commit 51b58c2 into main Dec 13, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc
benironside added a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page (#6269)

* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
benironside added a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page (#6269)

* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
benironside added a commit that referenced this pull request Dec 13, 2024
* Creates CSPM privileges standalone page (#6269)

* Creates CSPM privileges standalone page

* ports updates to serverless

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Apply suggestions from code review

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

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
(cherry picked from commit 51b58c2)

# Conflicts:
#	docs/serverless/cloud-native-security/cspm-get-started-azure.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started-gcp.asciidoc
#	docs/serverless/cloud-native-security/cspm-get-started.asciidoc
#	docs/serverless/index.asciidoc

* Delete docs/serverless directory and its contents

---------

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

Successfully merging this pull request may close these issues.

Update CSPM required permissions
4 participants