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

[8.16] Updates CSPM guides to include agentless option #5863

Merged
merged 17 commits into from
Nov 11, 2024

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Sep 26, 2024

Fixes #5606 by updating the CSPM deployment documentation to include the new agentless deployment option. Also fixes #4579 by updating the language about the Role ARN configuration field in the AWS guides.

Previews: Set up CSPM on azure
On GCP
On AWS
CSPM landing page

Copy link

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.

@elasticdocs

This comment was marked as outdated.

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.

A few line-edits, content looks good!

docs/cloud-native-security/cspm-get-started-aws.asciidoc Outdated Show resolved Hide resolved
docs/serverless/cloud-native-security/cspm-get-started.mdx Outdated Show resolved Hide resolved
docs/cloud-native-security/cspm-get-started-aws.asciidoc Outdated Show resolved Hide resolved
docs/serverless/cloud-native-security/cspm-get-started.mdx Outdated Show resolved Hide resolved
joepeeples
joepeeples previously approved these changes Oct 9, 2024
@benironside benironside requested a review from a team October 14, 2024 13:37
docs/cloud-native-security/cspm-get-started-aws.asciidoc Outdated Show resolved Hide resolved
docs/cloud-native-security/cspm-get-started-aws.asciidoc Outdated Show resolved Hide resolved
@@ -208,7 +224,7 @@ image::images/cspm-aws-auth-3.png[The EC2 page in AWS, showing the Modify IAM ro
.. Click *Update IAM role*.
.. Return to {kib} and <<cspm-finish-manual, finish manual setup>>.

IMPORTANT: Make sure to deploy the CSPM integration to this EC2 instance. When completing setup in {kib}, in the *Setup Access* section, select *Assume role* and leave *Role ARN* empty. Click *Save and continue*.
IMPORTANT: Make sure to deploy the CSPM integration to this EC2 instance. When completing setup in {kib}, in the *Setup Access* section, select *Assume role*. Leave **Role ARN** empty unless you want to specify a role the ((agent)) should assume instead of the default role for your EC2 instance. Click *Save and continue*.

[discrete]
[[cspm-use-keys-directly]]

Choose a reason for hiding this comment

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

@smriti0321 I think there are a few callouts or troubleshooting guide for missing regarding Agentless Onboarding.

  • Once agentless integration has been created, then the status column which takes a few refreshes to see the updated agent count. A callout message talking about the agentless deployment experience taking a minute or two before agent is enrolled and/or ingesting data could be useful here.
  • Customer enters the wrong credentials with deployed agent. Maybe guide the customer through that experience to rectify an issue with the Edit Flow or restarting with the deletion flow then creation flow again.
  • Agent is offline or unhealthy then inform customer can still access fleets agents page or explore errors in Logs Explorer.
  • Deletion flow - warn the customer that deletion will remove resources and stop data ingestion
  • Changing the fleet server will cause breaking changes. @smriti0321 See comment.

Choose a reason for hiding this comment

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

Great inputs @Omolola-Akinleye
@benironside is it possible to cover these in the FAQ for CSPM or you recommend any other place for troubleshooting agentless integrations?

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 think the FAQ seems like a good option. Let's cover this in our next sync

@benironside benironside changed the title [8.16] [serverless] Updates AWS CSPM guides to include agentless option [8.16] Updates AWS CSPM guides to include agentless option Oct 22, 2024
@benironside
Copy link
Contributor Author

Opened #6044 to track adding the troubleshooting steps that Omolola identified

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.

I left a few minor corrections and edits for your consideration, but looks great overall!

benironside and others added 2 commits November 1, 2024 16:09
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

This comment was marked as outdated.

@colleenmcginnis
Copy link
Contributor

@benironside I updated this PR to edit the serverless AsciiDoc file instead of the MDX file based on the changes made in #6061. Let me know if you have any questions!

@benironside benironside mentioned this pull request Nov 7, 2024
24 tasks
@benironside benironside changed the title [8.16] Updates AWS CSPM guides to include agentless option [8.16] Updates CSPM guides to include agentless option Nov 7, 2024
@benironside benironside merged commit 4e0ee5f into main Nov 11, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Nov 11, 2024
* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.asciidoc
#	docs/serverless/index.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 11, 2024
* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.asciidoc
#	docs/serverless/index.asciidoc
benironside added a commit that referenced this pull request Nov 11, 2024
…#5863) (#6109)

* [8.16]  Updates CSPM guides to include agentless option (#5863)

* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.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 Nov 12, 2024
#5863) (#6110)

* [8.16]  Updates CSPM guides to include agentless option (#5863)

* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.asciidoc
#	docs/serverless/index.asciidoc

* Delete docs/serverless directory and its contents

* Update docs/cloud-native-security/cloud-native-security-index.asciidoc

---------

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>
acorretti pushed a commit that referenced this pull request Nov 19, 2024
* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.asciidoc
#	docs/serverless/index.asciidoc
acorretti pushed a commit that referenced this pull request Nov 19, 2024
* Updates AWS CSPM guides to include agentless option

* Creates placeholder for agentless integrations page

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* Update docs/cloud-native-security/cspm-get-started-aws.asciidoc

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

* Update docs/serverless/cloud-native-security/cspm-get-started.mdx

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

* minor update

* Adds agentless options to CSPM docs

* Expand steps within the relevant sections

* Adds serverless updates

* Apply suggestions from code review

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

* update serverless asciidoc files instead of mdx files

* polishes serverless versions

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
(cherry picked from commit 4e0ee5f)

# 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/cloud-native-security/cspm.asciidoc
#	docs/serverless/index.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants