Skip to content

Commit 3ea403c

Browse files
author
iru
committed
chore(doc): enhance explanations and minor changes
1 parent fd73ba9 commit 3ea403c

File tree

10 files changed

+32
-28
lines changed

10 files changed

+32
-28
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ Notice that:
9797
```
9898
[profile secure-for-cloud]
9999
region=eu-central-1
100-
role_arn=arn:aws:iam::<AWS_MASTER_ORGANIZATION_ACCOUNT>:role/OrganizationAccountAccessRole
101-
source_profile=<AWS_MASTER_ACCOUNT_PROFILE>
100+
role_arn=arn:aws:iam::<AWS_MANAGEMENT_ORGANIZATION_ACCOUNT>:role/OrganizationAccountAccessRole
101+
source_profile=<AWS_MANAGEMENT_ACCOUNT_PROFILE>
102102
```
103103
104104
- Q: How to test **cloud-scanner** image-scanning?<br/>

examples-internal/single-account-benchmark/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ variable "sysdig_secure_api_token" {
1515
variable "region" {
1616
type = string
1717
default = "eu-central-1"
18-
description = "Default region for resource creation in both organization master and secure-for-cloud member account"
18+
description = "Default region for resource creation in both organization management and secure-for-cloud member account"
1919
}
2020

2121
variable "sysdig_secure_endpoint" {

examples-internal/single-account-scanning/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ provider "aws" {
66
# general resources
77
#-------------------------------------
88

9-
module "resource_group_master" {
9+
module "resource_group" {
1010
source = "../../modules/infrastructure/resource-group"
1111
name = var.name
1212
tags = var.tags

examples-internal/single-account-scanning/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ variable "name" {
4040
variable "region" {
4141
type = string
4242
default = "eu-central-1"
43-
description = "Default region for resource creation in both organization master and secure-for-cloud member account"
43+
description = "Default region for resource creation in both organization management and secure-for-cloud member account"
4444
}
4545

4646
variable "sysdig_secure_endpoint" {

examples-internal/single-account-without-bench/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ provider "aws" {
77
# general resources
88
#-------------------------------------
99

10-
module "resource_group_master" {
10+
module "resource_group" {
1111
source = "../../modules/infrastructure/resource-group"
1212
name = var.name
1313
tags = var.tags

examples-internal/single-account-without-bench/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ variable "cloudtrail_kms_enable" {
3232
variable "region" {
3333
type = string
3434
default = "eu-central-1"
35-
description = "Default region for resource creation in both organization master and secure-for-cloud member account"
35+
description = "Default region for resource creation in both organization management and secure-for-cloud member account"
3636
}
3737

3838
variable "name" {

examples/organizational/README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Sysdig Secure for Cloud in AWS :: Shared Organizational Trail
22

33
Deploy Sysdig Secure for Cloud sharing the Trail within an organization.
4-
* In the **master account**
5-
* An Organizational Cloutrail will be deployed
6-
* When an account becomes part of an organization, AWS will create an `OrganizationAccountAccessRole` [for account management](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html), which Sysdig Secure for Cloud will use for member-account provisioning.
7-
<br/>This Role is hardcoded ATM
8-
* In the **user-provided member account**:
9-
* An additional role `SysdigSecureForCloudRole` will be created within the master account, to be able to read cloudtrail-s3 bucket events
4+
5+
* In the **management account**
6+
* An Organizational Cloutrail will be deployed (with required S3,SNS)
7+
* An additional role `SysdigSecureForCloudRole` will be created
8+
* to be able to read cloudtrail-s3 bucket events from sysdig workload member account.
9+
* will also be used to asummeRole over other roles, and enable the process of scanning on ECR's that may be present in other member accounts.
10+
* In the **user-provided member account**
1011
* All the Sysdig Secure for Cloud service-related resources will be created
1112

1213
![organizational diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-secure-for-cloud/b95bf11fe513bda3c037144803d982a6e4225ce9/examples/organizational/diagram-org.png)
@@ -15,16 +16,20 @@ Deploy Sysdig Secure for Cloud sharing the Trail within an organization.
1516

1617
Minimum requirements:
1718

18-
1. Have an existing AWS account as the organization master account
19+
1. Have an existing AWS account as the organization management account
1920
* Organizational CloudTrail service must be enabled
20-
1. AWS profile credentials configuration of the `master` account of the organization
21+
2. AWS profile credentials configuration of the `management` account of the organization
2122
* This account credentials must be [able to manage cloudtrail creation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-trail-organization.html)
2223
> You must be logged in with the management account for the organization to create an organization trail. You must also have sufficient permissions for the IAM user or role in the management account to successfully create an organization trail.
23-
* Sysdig Secure for Cloud organizational member account id, as input variable value
24-
```
25-
sysdig_secure_for_cloud_member_account_id=<ORGANIZATIONAL_SECURE_FOR_CLOUD_ACCOUNT_ID>
26-
```
27-
1. Secure requirements, as input variable value
24+
* When an account becomes part of an organization, AWS will create an `OrganizationAccountAccessRole` [for account management](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html), which Sysdig Secure for Cloud will use for member-account provisioning and role assuming.
25+
<br/>This Role name is currently hardcoded.
26+
3. Provide a member account ID for Sysdig Secure for Cloud workload to be deployed.
27+
Our recommendation is for this account to be empty, so that deployed resources are not mixed up with your workload.
28+
This input must be provided as terraform required input value
29+
```
30+
sysdig_secure_for_cloud_member_account_id=<ORGANIZATIONAL_SECURE_FOR_CLOUD_ACCOUNT_ID>
31+
```
32+
4. Sysdig Secure requirements, as input variable value with the `api-token`
2833
```
2934
sysdig_secure_api_token=<SECURE_API_TOKEN>
3035
```
@@ -44,7 +49,7 @@ module "secure_for_cloud_organizational" {
4449

4550
See [inputs summary](#inputs) or module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/organizational/variables.tf) file for more optional configuration.
4651

47-
To run this example you need have your [aws master-account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
52+
To run this example you need have your [aws management-account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
4853
```terraform
4954
$ terraform init
5055
$ terraform plan
@@ -80,7 +85,7 @@ Notice that:
8085
| <a name="module_cloudtrail"></a> [cloudtrail](#module\_cloudtrail) | ../../modules/infrastructure/cloudtrail | |
8186
| <a name="module_codebuild"></a> [codebuild](#module\_codebuild) | ../../modules/infrastructure/codebuild | |
8287
| <a name="module_ecs_fargate_cluster"></a> [ecs\_fargate\_cluster](#module\_ecs\_fargate\_cluster) | ../../modules/infrastructure/ecs-fargate-cluster | |
83-
| <a name="module_resource_group_master"></a> [resource\_group\_master](#module\_resource\_group\_master) | ../../modules/infrastructure/resource-group | |
88+
| <a name="module_resource_group"></a> [resource\_group](#module\_resource\_group) | ../../modules/infrastructure/resource-group | |
8489
| <a name="module_resource_group_secure_for_cloud_member"></a> [resource\_group\_secure\_for\_cloud\_member](#module\_resource\_group\_secure\_for\_cloud\_member) | ../../modules/infrastructure/resource-group | |
8590
| <a name="module_secure_for_cloud_role"></a> [secure\_for\_cloud\_role](#module\_secure\_for\_cloud\_role) | ../../modules/infrastructure/organizational/secure-for-cloud-role | |
8691
| <a name="module_ssm"></a> [ssm](#module\_ssm) | ../../modules/infrastructure/ssm | |

examples/organizational/main.tf

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ provider "sysdig" {
1717
}
1818

1919
#-------------------------------------
20-
# resources deployed always in master account
20+
# resources deployed always in management account
2121
# with default provider
2222
#-------------------------------------
2323

24-
module "resource_group_master" {
24+
module "resource_group" {
2525
source = "../../modules/infrastructure/resource-group"
2626
name = var.name
2727
tags = var.tags
@@ -44,8 +44,7 @@ module "cloudtrail" {
4444

4545

4646
#-------------------------------------
47-
# resources deployed in master OR member account
48-
# with secure-for-cloud provider, which can be master or member config
47+
# secure-for-cloud member account workload
4948
#-------------------------------------
5049

5150
module "ecs_fargate_cluster" {

examples/single-account/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Notice that:
8585
| <a name="input_cloudtrail_is_multi_region_trail"></a> [cloudtrail\_is\_multi\_region\_trail](#input\_cloudtrail\_is\_multi\_region\_trail) | testing/economization purpose. true/false whether cloudtrail will ingest multiregional events | `bool` | `true` | no |
8686
| <a name="input_cloudtrail_kms_enable"></a> [cloudtrail\_kms\_enable](#input\_cloudtrail\_kms\_enable) | testing/economization purpose. true/false whether s3 should be encrypted | `bool` | `true` | no |
8787
| <a name="input_name"></a> [name](#input\_name) | Name for the Cloud Vision deployment | `string` | `"sysdig-secure-for-cloud"` | no |
88-
| <a name="input_region"></a> [region](#input\_region) | Default region for resource creation in both organization master and secure-for-cloud member account | `string` | `"eu-central-1"` | no |
88+
| <a name="input_region"></a> [region](#input\_region) | Default region for resource creation in both organization management and secure-for-cloud member account | `string` | `"eu-central-1"` | no |
8989
| <a name="input_sysdig_secure_endpoint"></a> [sysdig\_secure\_endpoint](#input\_sysdig\_secure\_endpoint) | Sysdig Secure API endpoint | `string` | `"https://secure.sysdig.com"` | no |
9090
| <a name="input_tags"></a> [tags](#input\_tags) | sysdig secure-for-cloud tags | `map(string)` | <pre>{<br> "product": "sysdig-secure-for-cloud"<br>}</pre> | no |
9191

examples/single-account/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ variable "cloudtrail_kms_enable" {
3232
variable "region" {
3333
type = string
3434
default = "eu-central-1"
35-
description = "Default region for resource creation in both organization master and secure-for-cloud member account"
35+
description = "Default region for resource creation in both organization management and secure-for-cloud member account"
3636
}
3737

3838
variable "name" {

0 commit comments

Comments
 (0)