Skip to content

Commit 492aa2c

Browse files
benironsiderhr323
authored andcommitted
Cloud connector deployment guides (elastic#3355)
Fixes elastic#2891 by creating documentation for the new technical preview deployment method for the CSPM and Asset Discovery security integrations. This deployment method provides secure-by-default, reusable deployment for cloud service provider (Azure, AWS, GCP) integrations by handling authentication behind the scenes. It uses a different method for each CSP. The current phase (phase 1) only supports Azure and AWS, and only for the CSPM and Asset Discovery integrations
1 parent 178d733 commit 492aa2c

File tree

6 files changed

+64
-10
lines changed

6 files changed

+64
-10
lines changed

solutions/security/cloud/asset-disc-aws.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,23 @@ Two deployment technologies are available: agentless and agent-based.
3636
4. Select **AWS**, then either **AWS Organization** to onboard multiple accounts, or **Single Account** to onboard an individual account.
3737
5. 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`.
3838
6. In **Deployment options**, select **Agentless**.
39-
7. Next, you’ll need to authenticate to AWS. Two methods are available:
39+
7. Next, you’ll need to authenticate to AWS. The following methods are available:
4040

41-
* Option 1: Direct access keys/CloudFormation (Recommended). For **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.
41+
* Option 1: Cloud connector (recommended). {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`
42+
* To use a pre-existing cloud connector for this deployment, select it under **Existing connection**.
43+
* To use a new cloud connector: under **New connection**, expand the **Steps to assume role** section. Complete the instructions to generate a `Role ARN` and `External ID`; enter them in {{kib}}.
44+
45+
::::{important}
46+
In order to use cloud connector for an AWS integration, your {{kib}} instance must be hosted on AWS. In other words, you must have chosen AWS hosting during {{kib}} setup.
47+
::::
48+
49+
* Option 2: Direct access keys/CloudFormation. For **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.
4250

4351
::::{note}
4452
If you don’t want to monitor every account in your organization, specify which to monitor using the `OrganizationalUnitIDs` field that appears after you click **Launch CloudFormation**.
4553
::::
4654

47-
* Option 2: Temporary keys. To authenticate using temporary keys, refer to the instructions for [temporary keys](/solutions/security/cloud/asset-disc-aws.md#cad-aws-temp-credentials).
55+
* Option 3: Temporary keys. To authenticate using temporary keys, refer to the instructions for [temporary keys](/solutions/security/cloud/asset-disc-aws.md#cad-aws-temp-credentials).
4856

4957
8. 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.
5058

solutions/security/cloud/asset-disc-azure.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ Two deployment technologies are available: agentless and agent-based.
3838
4. Select **Azure**, then either **Azure Organization** to onboard your whole organization, or **Single Subscription** to onboard an individual subscription.
3939
5. 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`.
4040
6. In **Deployment options**, select **Agentless**.
41-
7. 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 [Service principal with client secret](/solutions/security/cloud/asset-disc-azure.md#cad-azure-client-secret).
41+
7. Next, you’ll need to authenticate to Azure. The following methods are available:
42+
43+
* Option 1: Cloud connector (recommended). {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`
44+
Under **New connection**, expand the **Steps to create Managed User Identity in Azure** section. Complete the instructions to generate a `Client ID`, `Tenant ID`, and `Cloud Connector ID`, then enter them in {{kib}}.
45+
46+
* Option 2: Azure Client ID with Client Secret. Provide a **Client ID**, **Tenant ID**, and **Client Secret**. To learn how to generate them, refer to [Service principal with client secret](/solutions/security/cloud/asset-disc-azure.md#cad-azure-client-secret).
4247
8. Once you’ve provided the necessary credentials, click **Save and continue** to finish deployment. Your data should start to appear within a few minutes.
4348

4449
## Agent-based deployment [cad-azure-agent-based]

solutions/security/cloud/get-started-with-cspm-for-aws.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,23 @@ Two deployment technologies are available: agentless and agent-based.
4747
:::
4848

4949
7. In **Deployment options** select **Agentless**.
50-
8. Next, you’ll need to authenticate to AWS. Two methods are available:
50+
8. Next, you’ll need to authenticate to AWS. The following methods are available:
5151

52-
* Option 1: Direct access keys/CloudFormation (Recommended). For **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.
52+
* Option 1: Cloud connector (recommended). {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`
53+
* To use a pre-existing cloud connector for this deployment, select it under **Existing connection**.
54+
* To use a new cloud connector: under **New connection**, expand the **Steps to assume role** section. Complete the instructions to generate a `Role ARN` and `External ID`; enter them in {{kib}}.
55+
56+
::::{important}
57+
In order to use cloud connector for an AWS integration, your {{kib}} instance must be hosted on AWS. In other words, you must have chosen AWS hosting during {{kib}} setup.
58+
::::
59+
60+
* Option 2: Direct access keys/CloudFormation. For **Preferred method**, select **Direct access keys**. Expand the **Steps to Generate AWS Account Credentials** section, then follow the instructions to automatically create the necessary credentials using CloudFormation.
5361

5462
::::{note}
5563
If you don’t want to monitor every account in your organization, specify which to monitor using the `OrganizationalUnitIDs` field that appears after you click **Launch CloudFormation**.
5664
::::
5765

58-
* Option 2: Temporary keys. To authenticate using temporary keys, refer to the instructions for [temporary keys](/solutions/security/cloud/get-started-with-cspm-for-aws.md#cspm-use-temp-credentials).
66+
* Option 3: Temporary keys. To authenticate using temporary keys, refer to the instructions for [temporary keys](/solutions/security/cloud/get-started-with-cspm-for-aws.md#cspm-use-temp-credentials).
5967

6068
9. 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.
6169

solutions/security/cloud/get-started-with-cspm-for-azure.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This page explains how to get started monitoring the security posture of your cl
3131

3232
You can set up CSPM for Azure 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.
3333

34-
Two deployment technologies are available: agentless and agent-based.
34+
The following deployment technologies are available: agentless and agent-based.
3535

3636
* [Agentless deployment](/solutions/security/cloud/asset-disc-azure.md#cad-azure-agentless) allows you to collect cloud posture data without having to manage the deployment of an agent in your cloud.
3737
* [Agent-based deployment](/solutions/security/cloud/asset-disc-azure.md#cad-azure-agent-based) requires you to deploy and manage an agent in the cloud account you want to monitor.
@@ -50,7 +50,14 @@ Two deployment technologies are available: agentless and agent-based.
5050
:::
5151

5252
7. For **Deployment options**, select **Agentless**.
53-
8. For **Setup Access**, authenticate to Azure by providing a **Client ID**, **Tenant ID**, and **Client Secret**. To learn how to generate them, refer to [Service principal with client secret](/solutions/security/cloud/get-started-with-cspm-for-azure.md#cspm-azure-client-secret).
53+
8. Next, you’ll need to authenticate to Azure. The following methods are available:
54+
55+
* Option 1: Cloud connector (recommended). {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`
56+
Under **New connection**, expand the **Steps to create Managed User Identity in Azure** section. Complete the instructions to generate a `Client ID`, `Tenant ID`, and `Cloud Connector ID`, then enter them in {{kib}}.
57+
58+
* Option 2: Azure Client ID with Client Secret. Provide a **Client ID**, **Tenant ID**, and **Client Secret**. To learn how to generate them, refer to [Service principal with client secret](/solutions/security/cloud/get-started-with-cspm-for-azure.md#cspm-azure-client-secret).
59+
60+
5461
9. Once you’ve provided the necessary credentials, click **Save and continue** to finish deployment. Your data should start to appear within a few minutes.
5562

5663
## Agent-based deployment [cspm-azure-agent-based]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
navigation_title: Cloud connector authentication for agentless
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
security: preview
7+
---
8+
9+
# Authenticate agentless integrations using cloud connectors
10+
11+
Cloud connector authentication for agentless integrations reduces the administrative burden of authentating to third-party cloud service providers by eliminating the need to keep track of credentials such as API keys or passwords. Cloud connectors provide a reusable, secure-by-default means of authentication, helping you to manage deployments with many integrations collecting data from multiple cloud security providers.
12+
13+
## Where is cloud connector authentication supported?
14+
15+
At the current stage of this technical preview, a limited selection of cloud providers and integrations are supported.
16+
17+
You can use cloud connector deployment to authenticate with AWS and Azure while deploying either Elastic's Cloud Security Posture Management (CSPM) or Asset Discovery integration. For deployment instructions, refer to:
18+
19+
- Asset Discovery: [Asset Discovery on Azure](/solutions/security/cloud/asset-disc-azure.md); [Asset Discovery on AWS](/solutions/security/cloud/asset-disc-aws.md)
20+
- CSPM: [CSPM on Azure](/solutions/security/cloud/get-started-with-cspm-for-azure.md); [CSPM on AWS](/solutions/security/cloud/get-started-with-cspm-for-aws.md)
21+
22+
::::{important}
23+
In order to use cloud connector for an AWS integration, your {{kib}} instance must be hosted on AWS. In other words, you must have chosen AWS hosting during {{kib}} setup.
24+
::::

solutions/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,9 @@ toc:
531531
- file: security/get-started/automatic-import.md
532532
- file: security/get-started/content-connectors.md
533533
- file: security/get-started/agentless-integrations.md
534-
- file: security/get-started/agentless-integrations-faq.md
534+
children:
535+
- file: security/get-started/cloud-connector-deployment.md
536+
- file: security/get-started/agentless-integrations-faq.md
535537
- file: security/get-started/spaces-elastic-security.md
536538
children:
537539
- file: security/get-started/spaces-defend-faq.md

0 commit comments

Comments
 (0)