Skip to content

Commit fbe5b7f

Browse files
author
iru
authored
doc: clarify default admin role usage
1 parent f441078 commit fbe5b7f

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

examples/organizational/README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,17 @@ Minimum requirements:
2323
2. Configure [Terraform **AWS** Provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) for the `management` account of the organization
2424
* This provider credentials must be [able to manage cloudtrail creation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-trail-organization.html)
2525
> 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.
26-
* When an account is created within 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.
27-
* However, when the account is invited into the organization, it's required to [create the role manually](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role)
28-
> You have to do this manually, as shown in the following procedure. This essentially duplicates the role automatically set up for created accounts. We recommend that you use the same name, OrganizationAccountAccessRole, for your manually created roles for consistency and ease of remembering.
29-
* If role name, `OrganizationAccountAccessRole` wants to be modified, it must be done both on the `aws` member-account provider AND input value `organizational_member_default_admin_role`
26+
27+
3. Organizational Multi-Account Setup
28+
* An specific role is required, to enable Sysdig to impersonate and be able to provide
29+
* For the scanning feature, the ability to pull ECR hosted images when they're allocated in a different account
30+
* A solution to resolve current limitation when accessing an S3 bucket in a different region than where it's being called from
31+
* By default, it uses [AWS created default role `OrganizationAccountAccessRole`](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html)
32+
* When an account is created within 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.
33+
* However, when the account is invited into the organization, it's required to [create the role manually](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role)
34+
> You have to do this manually, as shown in the following procedure. This essentially duplicates the role automatically set up for created accounts. We recommend that you use the same name, OrganizationAccountAccessRole, for your manually created roles for consistency and ease of remembering.
35+
* If role name, `OrganizationAccountAccessRole` wants to be modified, it must be done both on the `aws` member-account provider AND input value `organizational_member_default_admin_role`
36+
3037
3. Provide a member **account ID for Sysdig Secure for Cloud workload** to be deployed.
3138
Our recommendation is for this account to be empty, so that deployed resources are not mixed up with your workload.
3239
This input must be provided as terraform required input value
@@ -39,25 +46,29 @@ Minimum requirements:
3946
```
4047
4148
42-
## Permission Summary
49+
## Role Summary
4350
4451
Permission requirement for this example comes as follows
4552
4653
- **management account**
4754
- terraform aws provider: default
4855
- `SysdigSecureForCloudRole` will be created
49-
- used by Sysdig to subscribe to cloudtrail-sns
56+
- used by Sysdig to subscribe to cloudtrail events
5057
- used by Sysdig to be able to jump to several member accounts to pull ECR hosted images through the `OrganizationAccountAccessRole` role
58+
- assumming previous role will also enable the access of cloudtrail s3 buckets when they are in a different region than were the terraform module is deployed
59+
5160
- `SysdigCloudBench` role will be created for SecurityAudit read-only purpose, used by Sysdig to benchmark
61+
5262
- **member accounts**
5363
- terraform aws provider: 'member' aliased
5464
- this provider can be configured as desired, we just provide a default option
55-
- requires [`OrganizationAccountAccessRole`](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) default role created by AWS for managed-account users to be able to admin member accounts
65+
- by default, we suggest using an assumeRole to the [AWS created default role `OrganizationAccountAccessRole`](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html)
5666
- if this role does not exist provide input var `organizational_member_default_admin_role` with the role
5767
- `SysdigCloudBench` role will be created for SecurityAudit read-only purpose, used by Sysdig to benchmark
58-
- **sysdig member account workload**
59-
- if ECS workload is deployed, `ECSTaskRole` will be used to define its permissions
60-
- used by Sysdig to assumeRole on management account `SysdigSecureForCloudRole` and other organizations `OrganizationAccountAccessRole`
68+
69+
- **sysdig workload member account**
70+
- if ECS workload is deployed, `ECSTaskRole` will be used to define its permissions
71+
- used by Sysdig to assumeRole on management account `SysdigSecureForCloudRole` and other organizations `OrganizationAccountAccessRole`
6172
6273
## Notice
6374

0 commit comments

Comments
 (0)