Skip to content

Commit 282c3bb

Browse files
committed
SAAS-23305: Updating README.md
1 parent c6dae7f commit 282c3bb

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

examples/dedicated-project/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Overview
66

7-
This example shows how to onboard a GCP project by creating a dedicated project to provision all of Aqua’s resources into and apply the required labels for Aqua Security integration.
7+
This example demonstrates how to onboard a GCP project by creating a dedicated project to provision all of Aqua’s resources into and apply the required labels for Aqua Security integration.
88

99
## Pre-requisites
1010

@@ -16,15 +16,21 @@ Before running this example, ensure that you have the following:
1616

1717
## Usage
1818

19-
1. Leverage the Aqua platform to generate the local variables required by the module.
19+
1. Obtain the Terraform configuration file generated by the Aqua Security UI.
2020
2. Important: Replace `<aqua_api_key>` and `<aqua_api_secret>` with your generated API credentials.
2121
3. Run `terraform init` to initialize the Terraform working directory.
2222
4. Run `terraform apply` to create the dedicated project.
2323

2424
## What's Happening
25-
1. The `aqua_gcp_dedicated_project` module is called to create a dedicated GCP project is created with the name `aqua-agentless-<tenant_id>-<org_hash>`, where `org_hash` is the first six characters of the SHA1 hash of your organization name.
25+
26+
1. The `aqua_gcp_dedicated_project` module is called to create a dedicated GCP project with the name `aqua-agentless-<tenant_id>-<org_hash>`, where `org_hash` is the first six characters of the SHA1 hash of your organization name.
2627
2. The `aqua_gcp_onboarding` module is called to provision the necessary resources (service accounts, roles, networking, etc.) in the dedicated GCP project.
27-
3. The `aqua_gcp_project_attachment` module is called to create the required IAM resources in the onboarding project and trigger the Aqua API.
28+
3. The `aqua_gcp_project_attachment` module is called to create the required IAM resources in the existing project and trigger the Aqua API to onboard the project.
29+
30+
31+
## Outputs
32+
33+
- `onboarding_status`: The output from the `aqua_gcp_project_attachment` module, displaying the result of the onboarding process.
2834

2935
## Cleanup
3036

examples/same-project/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Overview
66

7-
This example shows how to onboard a Google Cloud Platform (GCP) project by provisioning all of Aqua’s resources into the existing project.
7+
This example demonstrates how to onboard an existing Google Cloud Platform (GCP) project to Aqua Security by provisioning all the necessary resources directly into the existing project, without creating a dedicated project.
88

99
## Prerequisites
1010

@@ -16,15 +16,19 @@ Before running this example, ensure that you have the following:
1616

1717
## Usage
1818

19-
1. Replace the placeholder values in the `locals` block with your actual values.
20-
2. Run `terraform init` to initialize the Terraform working directory.
21-
3. Run `terraform apply` to create the resources.
19+
1. Obtain the Terraform configuration file generated by the Aqua Security UI.
20+
2. Replace the placeholders `<aqua_api_key>` and `<aqua_api_secret>` with your actual Aqua Security API key and secret.
21+
3. Run `terraform init` to initialize the Terraform working directory.
22+
4. Run `terraform apply` to create the resources.
2223

2324
## What's Happening
2425

25-
1. The `aqua_gcp_onboarding` module is called to provision the necessary resources (service accounts, roles, networking, etc.) in the existing GCP project.
26-
2. The `aqua_gcp_project_attachment` module is called to create the required IAM resources in the onboarding project and trigger the Aqua API.
26+
1. The `aqua_gcp_onboarding` module is called to provision the necessary resources (service accounts, roles, networking, etc.) directly in the existing GCP project.
27+
2. The `aqua_gcp_project_attachment` module is called to create the required IAM resources in the existing project and trigger the Aqua API to onboard the project.
2728

29+
## Outputs
30+
31+
- `onboarding_status`: The output from the `aqua_gcp_project_attachment` module, displaying the result of the onboarding process.
2832

2933
## Cleanup
3034

0 commit comments

Comments
 (0)