From d1f2898588387dd05e003e03ec67a4e0a6d4f5ad Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 12 Nov 2024 00:19:13 +0000 Subject: [PATCH] [8.16] [8.16] Updates CSPM guides to include agentless option (backport #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 * Update docs/serverless/cloud-native-security/cspm-get-started.mdx Co-authored-by: Joe Peeples * Update docs/cloud-native-security/cspm-get-started-aws.asciidoc Co-authored-by: Joe Peeples * Update docs/serverless/cloud-native-security/cspm-get-started.mdx Co-authored-by: Joe Peeples * 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 Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: Colleen McGinnis (cherry picked from commit 4e0ee5f1052f8e9705812a5f84694565eb554817) # 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] --- .../cloud-native-security-index.asciidoc | 2 +- .../cspm-get-started-aws.asciidoc | 49 +++++++++++++------ .../cspm-get-started-azure.asciidoc | 19 ++++++- .../cspm-get-started-gcp.asciidoc | 22 ++++++++- docs/cloud-native-security/cspm.asciidoc | 2 +- .../agentless-integrations.asciidoc | 10 ++++ docs/getting-started/index.asciidoc | 1 + 7 files changed, 86 insertions(+), 19 deletions(-) create mode 100644 docs/getting-started/agentless-integrations.asciidoc diff --git a/docs/cloud-native-security/cloud-native-security-index.asciidoc b/docs/cloud-native-security/cloud-native-security-index.asciidoc index 67ee78ce17..63d5cc827b 100644 --- a/docs/cloud-native-security/cloud-native-security-index.asciidoc +++ b/docs/cloud-native-security/cloud-native-security-index.asciidoc @@ -8,7 +8,7 @@ This page describes what each solution does and provides links to more informati == Cloud Security Posture Management (CSPM) Discovers and evaluates the services in your cloud environment — like storage, compute, IAM, and more — against configuration security guidelines defined by the https://www.cisecurity.org/[Center for Internet Security] (CIS) to help you identify and remediate risks that could undermine the confidentiality, integrity, and availability of your cloud data. -To learn more, refer to <>. +<>. [discrete] == Kubernetes Security Posture Management (KSPM) diff --git a/docs/cloud-native-security/cspm-get-started-aws.asciidoc b/docs/cloud-native-security/cspm-get-started-aws.asciidoc index 0ac9c8265c..bdcd180d80 100644 --- a/docs/cloud-native-security/cspm-get-started-aws.asciidoc +++ b/docs/cloud-native-security/cspm-get-started-aws.asciidoc @@ -28,11 +28,31 @@ This page explains how to get started monitoring the security posture of your cl [[cspm-setup]] == Set up CSPM for AWS -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. +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. Two deployment technologies are available: agentless, and agent-based. <> allows you to collect cloud posture data without having to manage the deployment of {agent} in your cloud. <> requires you to deploy and manage {agent} in the cloud account you want to monitor. + +[discrete] +[[cspm-aws-agentless]] +== Agentless deployment +beta::[] + +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Select *AWS*, then either *AWS Organization* to onboard multiple accounts, or *Single Account* to onboard an individual account. +. Give your integration a name that matches the purpose or team of the AWS account/organization you want to monitor, for example, `dev-aws-account`. +. Click **Advanced options**, then select **Agentless (BETA)**. +. Next, you'll need to authenticate to AWS. Two methods are available: +.. Option 1: Direct access keys/CloudFormation (Recommended). Under **Preferred method**, select **Direct access keys**. Expand the **Steps to Generate AWS Account Credentials** section, then follow the displayed instructions to automatically create the necessary credentials using CloudFormation. +.. Option 2: Temporary keys. To authenticate using temporary keys, refer to the instructions for <>. +. Once you've selected an authentication method and provided all necessary credentials, click **Save and continue** to finish deployment. Your data should start to appear within a few minutes. + +[discrete] +[[cspm-aws-agent-based]] +== Agent-based deployment [discrete] [[cspm-add-and-name-integration]] -== Add the CSPM integration +=== Add the CSPM integration . From the Elastic Security *Get started* page, click *Add integrations*. . Search for `CSPM`, then click on the result. . Click *Add Cloud Security Posture Management (CSPM)*. @@ -42,11 +62,12 @@ You can set up CSPM for AWS either by enrolling a single cloud account, or by en [discrete] [[cspm-set-up-cloud-access-section]] -== Set up cloud account access -The CSPM integration requires access to AWS’s built-in https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html#jf_security-auditor[`SecurityAudit` IAM policy] in order to discover and evaluate resources in your cloud account. There are several ways to provide access. +=== Set up cloud account access +The CSPM integration requires access to AWS's built-in https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html#jf_security-auditor[`SecurityAudit` IAM policy] in order to discover and evaluate resources in your cloud account. There are several ways to provide access. For most use cases, the simplest option is to use AWS CloudFormation to automatically provision the necessary resources and permissions in your AWS account. This method, as well as several manual options, are described below. + [discrete] [[cspm-set-up-cloudformation]] === CloudFormation (recommended) @@ -68,7 +89,7 @@ When you return to {kib}, click *View assets* to review the data being collected [discrete] [[cspm-setup-organization-manual]] -== Manual authentication for organization-level onboarding +=== Manual authentication for organization-level onboarding NOTE: If you're onboarding a single account instead of an organization, skip this section. @@ -168,7 +189,7 @@ IMPORTANT: When deploying to an organization using any of the authentication met [discrete] [[cspm-set-up-manual]] -== Manual authentication methods +=== Manual authentication methods * <> * <> @@ -180,7 +201,7 @@ IMPORTANT: Whichever method you use to authenticate, make sure AWS’s built-in [discrete] [[cspm-use-instance-role]] -=== Option 1 - Default instance role +==== Option 1 - Default instance role NOTE: If you are deploying to an AWS organization instead of an AWS account, you should already have <>, `cloudbeat-root`. Skip to step 2 "Attach your new IAM role to an EC2 instance", and attach this role. You can use either an existing or new EC2 instance. @@ -208,11 +229,11 @@ 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 <>. -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 for agentless deployments. For agent-based deployments, leave it 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]] -=== Option 2 - Direct access keys +==== Option 2 - Direct access keys Access keys are long-term credentials for an IAM user or AWS account root user. To use access keys as credentials, you must provide the `Access key ID` and the `Secret Access Key`. After you provide credentials, <>. For more details, refer to https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html[Access Keys and Secret Access Keys]. @@ -221,8 +242,8 @@ IMPORTANT: You must select *Programmatic access* when creating the IAM user. [discrete] [[cspm-use-temp-credentials]] -=== Option 3 - Temporary security credentials -You can configure temporary security credentials in AWS to last for a specified duration. They consist of an access key ID, a secret access key, and a security token, which is typically found using `GetSessionToken`. +==== Option 3 - Temporary security credentials +You can configure temporary security credentials in AWS to last for a specified duration. They consist of an access key ID, a secret access key, and a session token, which is typically found using `GetSessionToken`. Because temporary security credentials are short term, once they expire, you will need to generate new ones and manually update the integration's configuration to continue collecting cloud posture data. Update the credentials before they expire to avoid data loss. @@ -245,7 +266,7 @@ After you provide credentials, <>. [discrete] [[cspm-use-a-shared-credentials-file]] -=== Option 4 - Shared credentials file +==== Option 4 - Shared credentials file If you use different AWS credentials for different tools or applications, you can use profiles to define multiple access keys in the same configuration file. For more details, refer to AWS' https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html[Shared Credentials Files] documentation. Instead of providing the `Access key ID` and `Secret Access Key` to the integration, provide the information required to locate the access keys within the shared credentials file: @@ -264,14 +285,14 @@ After providing credentials, <>. [discrete] [[cspm-use-iam-arn]] -=== Option 5 - IAM role Amazon Resource Name (ARN) +==== Option 5 - IAM role Amazon Resource Name (ARN) An IAM role Amazon Resource Name (ARN) is an IAM identity that you can create in your AWS account. You define the role's permissions. Roles do not have standard long-term credentials such as passwords or access keys. Instead, when you assume a role, it provides temporary security credentials for your session. To use an IAM role ARN, select *Assume role* under *Preferred manual method*, enter the ARN, and continue to Finish manual setup. [discrete] [[cspm-finish-manual]] -== Finish manual setup +=== Finish manual setup Once you’ve provided AWS credentials, under *Where to add this integration*: If you want to monitor an AWS account or organization where you have not yet deployed {agent}: diff --git a/docs/cloud-native-security/cspm-get-started-azure.asciidoc b/docs/cloud-native-security/cspm-get-started-azure.asciidoc index 101a8e2ffc..f47322abc0 100644 --- a/docs/cloud-native-security/cspm-get-started-azure.asciidoc +++ b/docs/cloud-native-security/cspm-get-started-azure.asciidoc @@ -28,8 +28,25 @@ This page explains how to get started monitoring the security posture of your cl [[cspm-setup-azure]] == Set up CSPM for Azure -You can set up CSPM for Azure by by enrolling an Azure organization (management group) containing multiple subscriptions, or by enrolling a single subscription. Either way, first add the CSPM integration, then enable cloud account access. +You can set up CSPM for Azure by by enrolling an Azure organization (management group) containing multiple subscriptions, or by enrolling a single subscription. Either way, first add the CSPM integration, then enable cloud account access. Two deployment technologies are available: agentless, and agent-based. <> allows you to collect cloud posture data without having to manage the deployment of an agent in your cloud. <> requires you to deploy and manage an agent in the cloud account you want to monitor. +[discrete] +[[cspm-azure-agentless]] +== Agentless deployment +beta::[] + +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Select *Azure*, then either *Azure Organization* to onboard your whole organization, or *Single Subscription* to onboard an individual subscription. +. Give your integration a name that matches the purpose or team of the Azure subscription/organization you want to monitor, for example, `dev-azure-account`. +. Click **Advanced options**, then select **Agentless (BETA)**. +. Next, you'll need to authenticate to Azure by providing a **Client ID**, **Tenant ID**, and **Client Secret**. To learn how to generate them, refer to <>. +. Once you've provided the necessary credentials, click **Save and continue** to finish deployment. Your data should start to appear within a few minutes. + +[discrete] +[[cspm-azure-agent-based]] +== Agent-based deployment [discrete] [[cspm-add-and-name-integration-azure]] diff --git a/docs/cloud-native-security/cspm-get-started-gcp.asciidoc b/docs/cloud-native-security/cspm-get-started-gcp.asciidoc index dec49e4ccc..e7cf9d9f62 100644 --- a/docs/cloud-native-security/cspm-get-started-gcp.asciidoc +++ b/docs/cloud-native-security/cspm-get-started-gcp.asciidoc @@ -26,10 +26,28 @@ This page explains how to get started monitoring the security posture of your GC [discrete] [[cspm-setup-gcp]] -== Initial setup +== Set up CSPM for GCP -You can set up CSPM for GCP either by enrolling a single project, or by enrolling an organization containing multiple projects. Either way, you need to first add the CSPM integration, then enable cloud account access. +You can set up CSPM for GCP either by enrolling a single project, or by enrolling an organization containing multiple projects. Either way, you need to first add the CSPM integration, then enable cloud account access. Two deployment technologies are available: agentless, and agent-based. <> allows you to collect cloud posture data without having to manage the deployment of an agent in your cloud. <> requires you to deploy and manage an agent in the cloud account you want to monitor. +[discrete] +[[cspm-gcp-agentless]] +== Agentless deployment +beta::[] + +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Select *GCP*, then either *GCP Organization* to onboard your whole organization, or *Single Account* to onboard an individual account. +. Give your integration a name that matches the purpose or team of the GCP subscription/organization you want to monitor, for example, `dev-gcp-account`. +. Click **Advanced options**, then select **Agentless (BETA)**. +. Next, you'll need to authenticate to GCP. Expand the **Steps to Generate GCP Account Credentials** section, then follow the instructions that appear to automatically create the necessary credentials using Google Cloud Shell. +. Once you've provided the necessary credentials, click **Save and continue** to finish deployment. Your data should start to appear within a few minutes. + + +[discrete] +[[cspm-gcp-agent-based]] +== Agent-based deployment [discrete] [[cspm-add-and-name-integration-gcp]] diff --git a/docs/cloud-native-security/cspm.asciidoc b/docs/cloud-native-security/cspm.asciidoc index 6ffeb3a1c7..532f2efe3e 100644 --- a/docs/cloud-native-security/cspm.asciidoc +++ b/docs/cloud-native-security/cspm.asciidoc @@ -3,7 +3,7 @@ The Cloud Security Posture Management (CSPM) feature discovers and evaluates the services in your cloud environment — like storage, compute, IAM, and more — against configuration security guidelines defined by the https://www.cisecurity.org/[Center for Internet Security] (CIS) to help you identify and remediate risks that could undermine the confidentiality, integrity, and availability of your cloud data. -This feature currently supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. For step-by-step getting started guides, refer to <>, <>, or <>. +This feature currently supports agentless and agent-based deployments on Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. For step-by-step getting started guides, refer to <>, <>, or <>. .Requirements [sidebar] diff --git a/docs/getting-started/agentless-integrations.asciidoc b/docs/getting-started/agentless-integrations.asciidoc new file mode 100644 index 0000000000..d0aab1c39a --- /dev/null +++ b/docs/getting-started/agentless-integrations.asciidoc @@ -0,0 +1,10 @@ +[[agentless-integrations]] += Agentless integrations + +beta::[] + +Agentless integrations provide a means to ingest data while avoiding the orchestration, management, and maintenance needs associated with standard ingest infrastructure. Using agentless integrations makes manual agent deployment unnecessary, allowing you to focus on your data instead of the agent that collects it. + +We currently support one agentless integration: cloud security posture management (CSPM). Using this integration's agentless deployment option, you can enable Elastic's CSPM capabilities just by providing the necessary credentials. Agentless CSPM deployments support AWS, Azure, and GCP accounts. + +To learn more about agentless CSPM deployments, refer to the getting started guides for CSPM on <>, <>, or <>. \ No newline at end of file diff --git a/docs/getting-started/index.asciidoc b/docs/getting-started/index.asciidoc index eecbaa4a8f..64daa518ae 100644 --- a/docs/getting-started/index.asciidoc +++ b/docs/getting-started/index.asciidoc @@ -13,6 +13,7 @@ include::security-ui.asciidoc[leveloffset=+1] include::ingest-data.asciidoc[leveloffset=+1] include::threat-intel-integrations.asciidoc[leveloffset=+2] include::automatic-import.asciidoc[leveloffset=+2] +include::agentless-integrations.asciidoc[leveloffset=+2] include::security-spaces.asciidoc[leveloffset=+1]