Skip to content

Commit 1fbc832

Browse files
authored
improve docs (#823)
1 parent 881b1c7 commit 1fbc832

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

docs/installation/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,9 @@ Issues in Older Releases:
333333
**Release Specific Upgrade Considerations:**
334334

335335
- Upgrades to `v1.3.9 and above` from `v1.3.8-b and below`:
336-
- Requires the removal of any interface endpoints containing a period (sub-domain) either before or during the upgrade process (ecr.dkr, ecr.api, transfer.server, sagemaker.api, sagemaker.runtime in the full config.json example)
336+
- All interface endpoints containing a period must be removed from the config.json file either before or during the upgrade process
337+
- i.e. ecr.dkr, ecr.api, transfer.server, sagemaker.api, sagemaker.runtime in the full config.json example
338+
- If you remove them on a pre-upgrade State Machine execution, you can put them back during the upgrade, if you remove them during the upgrade, you can put them back post upgrade.
337339
- Upgrades to `v1.3.3 and above` from `v1.3.2 and below`:
338340
- Requires mandatory config file schema changes as documented in the [release notes](https://github.com/aws-samples/aws-secure-environment-accelerator/releases).
339341
- These updates cause the config file change validation to fail and require running the state machine with the following input to override the validation checks on impacted fields: `{"scope": "FULL", "mode": "APPLY", "configOverrides": {"ov-ou-vpc": true, "ov-ou-subnet": true, "ov-acct-vpc": true }}`

reference-artifacts/SAMPLE_CONFIGS/sample_snippets.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,26 @@ In vpc section, under interface endpoints:
3333

3434
---
3535

36-
## - Create a role with trust policies
36+
## - Cross Account Role Example with trust policies (trust policies not supported until v1.5.0+)
3737

3838
```
3939
{
4040
"role": "Demo-Role",
41-
"type": "other",
41+
"type": "account",
4242
"policies": ["AdministratorAccess"],
4343
"boundary-policy": "Default-Boundary-Policy",
4444
"source-account": "operations",
45-
"source-account-role": "TempAdmin",
46-
"trust-policy": "none"
45+
"source-account-role": "Admin",
46+
"trust-policy": "role-trust-policy.txt"
4747
}
4848
```
49+
Notes:
50+
- if "source-account" and "source-account-role" are specified, a cross-account role will be created
51+
- "type" can be any value if "source-account" and "acource-account-role" are specified (not used, but required)
52+
- "type" is the AWS service name if creating a service role (i.e. ec2)
53+
- "trust-policy" is only applied to cross-account roles and not service roles
54+
- the trust policy is interpreted, not all custom trust policy values may be implemented
55+
- for example, we always use the action sts:AssumeRole
4956

5057
---
5158

@@ -344,20 +351,7 @@ This is typically only deployed in the perimeter account, but could be used else
344351

345352
---
346353

347-
## - Cross Account Role Example
348-
349-
```
350-
{
351-
"role": "Test-Role",
352-
"type": "account",
353-
"policies": ["AdministratorAccess"],
354-
"boundary-policy": "Default-Boundary-Policy",
355-
"source-account": "security",
356-
"source-account-role": "AWSLandingZoneSecurityAdministratorRole",
357-
"trust-policy": "role-trust-policy.txt"
358-
}
359-
```
360-
354+
xx
361355
---
362356

363357
## - Very basic workload account example and "per account" exceptions example

0 commit comments

Comments
 (0)