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 AWS CSPM guides to include agentless option #5863

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

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.

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
Copy link

elasticdocs commented Sep 26, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

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
@@ -30,6 +30,21 @@ This page explains how to get started monitoring the security posture of your cl

You can set up CSPM for AWS either by enrolling a single cloud account, or by enrolling an organization containing multiple accounts. Either way, first you will add the CSPM integration, then enable cloud account access.

[discrete]
[[cspm-aws-agentless]]
== Agentless deployment option

Choose a reason for hiding this comment

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

I would suggest adding a header for agentless deployment option and capture the methods supported under that section. Also, as per the beta guide shared, you could also add some description of the agentless method and when user would choose this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When would a user not want to use agentless deployment?

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 don't want to explain the entire authentication methods twice on the same page (once for agentless and once for agent-based), but I added more detail about the steps other than authentication to this section, and link to the authentication methods.

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
@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
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.

[Request] Agentless deployment option for CSPM to be documented with Beta tag
5 participants