Skip to content

Commit e3412cd

Browse files
authored
Tweaks docs for AMI issue and CT latest (#1028)
1 parent 4f12fdd commit e3412cd

File tree

3 files changed

+46
-32
lines changed

3 files changed

+46
-32
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A common misconception is that the AWS Secure Environment Accelerator only deplo
1414

1515
Additionally, while the Accelerator is initially responsible for deploying a prescribed architecture, it more importantly allows for organizations to operate, evolve, and maintain their cloud architecture and security controls over time and as they grow, with minimal effort, often using native AWS tools. While the Accelerator helps with the deployment of technical security controls, it’s important to understand that the Accelerator is only part of your security and compliance effort. We encourage customers to work with their AWS account team, AWS Professional Services or an AWS Partner to determine how to best meet the remainder of your compliance requirements.
1616

17-
The Accelerator is designed to enable customers to upgrade across Accelerator versions while maintaining a customer’s specific configuration and customizations, and without the need for any coding expertise or for Professional Services. Customers have been able to seamlessly upgrade their AWS multi-account environment from the very first Accelerator beta release to the latest release (across more than 50 releases), gaining the benefits of bug fixes and enhancements while having the option to enable new features, without any loss of existing customization or functionality.
17+
The Accelerator is designed to enable customers to upgrade across Accelerator versions while maintaining a customer’s specific configuration and customizations, and without the need for any coding expertise or for professional services. Customers have been able to seamlessly upgrade their AWS multi-account environment from the very first Accelerator beta release to the latest release (across more than 50 releases), gaining the benefits of bug fixes and enhancements while having the option to enable new features, without any loss of existing customization or functionality.
1818

1919
Specifically the accelerator deploys and manages the following functionality, both at initial accelerator deployment and as new accounts are created, added, or onboarded in a completely automated but customizable manner:
2020

@@ -28,23 +28,24 @@ Specifically the accelerator deploys and manages the following functionality, bo
2828
- Security Tooling
2929
- Workload Accounts - automated concurrent mass account creation or use AWS organizations to scale one account at a time. These accounts are used to host a customer's workloads and applications.
3030
- Scalable to 1000's of AWS accounts
31-
- Supports AWS Organizations nested [ou's](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) and importing existing AWS accounts
31+
- Supports AWS Organizations nested [OU's](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) and importing existing AWS accounts
3232
- Performs 'account warming' to establish initial limits, when required
3333
- Automatically submits limit increases, when required (complies with initial limits until increased)
34-
- Leverages AWS Control Tower **(NEW)**
34+
- Leverages AWS Control Tower
3535

3636
### Creates Networking
3737

3838
- Transit Gateways and TGW route tables (incl. inter-region TGW peering)
3939
- Centralized and/or Local (bespoke) VPC's
4040
- Subnets, Route tables, NACLs, Security groups, NATGWs, IGWs, VGWs, CGWs
41+
- **NEW** Outpost, Local Zone and Wavelength support
4142
- VPC Endpoints (Gateway and Interface, Centralized or Local)
4243
- Route 53 Private and Public Zones, Resolver Rules and Endpoints, VPC Endpoint Overloaded Zones
4344
- All completely and individually customizable (per account, VPC, subnet, or OU)
4445
- Layout and customize your VPCs, subnets, CIDRs and connectivity the way you want
45-
- Static or Dynamic **(NEW)** VPC and subnet CIDR assignments
46+
- Static or Dynamic VPC and subnet CIDR assignments
4647
- Deletes default VPC's (worldwide)
47-
- AWS Network Firewall **(NEW)**
48+
- AWS Network Firewall
4849

4950
### Cross-Account Object Sharing
5051

@@ -70,7 +71,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
7071
### Cloud Security Services
7172

7273
- Enables and configures the following AWS services, worldwide w/central designated admin account:
73-
- Guardduty w/S3 protection
74+
- GuardDuty w/S3 protection
7475
- Security Hub (Enables designated security standards, and disables individual controls)
7576
- Firewall Manager
7677
- CloudTrail w/Insights and S3 data plane logging
@@ -87,11 +88,11 @@ Specifically the accelerator deploys and manages the following functionality, bo
8788
- Enables account level default EBS encryption and S3 Block Public Access
8889
- Configures Systems Manager Session Manager w/KMS encryption and centralized logging
8990
- Configures Systems Manager Inventory w/centralized logging
90-
- Creates and configures AWS budgets (customizable per ou and per account)
91+
- Creates and configures AWS budgets (customizable per OU and per account)
9192
- Imports or requests certificates into AWS Certificate Manager
9293
- Deploys both perimeter and account level ALB's w/Lambda health checks, certificates and TLS policies
9394
- Deploys & configures 3rd party firewall clusters and management instances (leverages marketplace)
94-
- Gateway Load Balancer w/auto-scaling **(NEW)** and VPN IPSec BGP ECMP deployment options
95+
- Gateway Load Balancer w/auto-scaling and VPN IPSec BGP ECMP deployment options
9596
- Protects Accelerator deployed and managed objects
9697
- Sets Up SNS Alerting topics (High, Medium, Low, Blackhole priorities)
9798
- Deploys CloudWatch Log Metrics and Alarms
@@ -111,19 +112,20 @@ Specifically the accelerator deploys and manages the following functionality, bo
111112
- GuardDuty Findings
112113
- Macie Discovery results
113114
- ALB Logs
114-
- SSM Inventory **(NEW)**
115-
- Security Hub findings **(NEW)**
115+
- SSM Inventory
116+
- Security Hub findings
116117
- SSM Session Logs (also sent to CWL)
117118
- Resolver Query Logs (also sent to CWL)
118-
- Email alerting for CloudTrail Metric Alarms, Firewall Manager Events **(NEW)**, Security Hub Findings incl. Guardduty Findings **(NEW)**
119+
- Email alerting for CloudTrail Metric Alarms, Firewall Manager Events, Security Hub Findings incl. GuardDuty Findings
120+
- **NEW** Optionally collect Organization and ASEA configuration and metadata in a new restricted log archive bucket
119121

120122
## Relationship with AWS Landing Zone Solution (ALZ)
121123

122124
The ALZ was an AWS Solution designed to deploy a multi-account AWS architecture for customers based on best practices and lessons learned from some of AWS' largest customers. The AWS Accelerator draws on design patterns from the Landing Zone, and re-uses several concepts and nomenclature, but it is not directly derived from it, nor does it leverage any code from the ALZ. The Accelerator is a standalone solution with no dependence on ALZ.
123125

124126
## Relationship with AWS Control Tower
125127

126-
The AWS Secure Environment Accelerator now leverages AWS Control Tower! **(NEW)**
128+
The AWS Secure Environment Accelerator now leverages AWS Control Tower!
127129

128130
With the release of v1.5.0, the AWS Accelerator adds the capability to be deployed on top of AWS Control Tower. Customers get the benefits of the fully managed capabilities of AWS Control Tower combined with the power and flexibility of the Accelerators Networking and Security orchestration.
129131

src/mkdocs/docs/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,21 @@ Specifically the accelerator deploys and manages the following functionality, bo
3333
- Supports AWS Organizations nested [OU's](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) and importing existing AWS accounts
3434
- Performs 'account warming' to establish initial limits, when required
3535
- Automatically submits limit increases, when required (complies with initial limits until increased)
36-
- Leverages AWS Control Tower **(NEW)**
36+
- Leverages AWS Control Tower
3737

3838
### 1.2.2. Creates Networking
3939

4040
- Transit Gateways and TGW route tables (incl. inter-region TGW peering)
4141
- Centralized and/or Local (bespoke) VPC's
4242
- Subnets, Route tables, NACLs, Security groups, NATGWs, IGWs, VGWs, CGWs
43+
- **NEW** Outpost, Local Zone and Wavelength support
4344
- VPC Endpoints (Gateway and Interface, Centralized or Local)
4445
- Route 53 Private and Public Zones, Resolver Rules and Endpoints, VPC Endpoint Overloaded Zones
4546
- All completely and individually customizable (per account, VPC, subnet, or OU)
4647
- Layout and customize your VPCs, subnets, CIDRs and connectivity the way you want
47-
- Static or Dynamic **(NEW)** VPC and subnet CIDR assignments
48+
- Static or Dynamic VPC and subnet CIDR assignments
4849
- Deletes default VPC's (worldwide)
49-
- AWS Network Firewall **(NEW)**
50+
- AWS Network Firewall
5051

5152
### 1.2.3. Cross-Account Object Sharing
5253

@@ -93,11 +94,11 @@ Specifically the accelerator deploys and manages the following functionality, bo
9394
- Imports or requests certificates into AWS Certificate Manager
9495
- Deploys both perimeter and account level ALB's w/Lambda health checks, certificates and TLS policies
9596
- Deploys & configures 3rd party firewall clusters and management instances (leverages marketplace)
96-
- Gateway Load Balancer w/auto-scaling **(NEW)** and VPN IPSec BGP ECMP deployment options
97+
- Gateway Load Balancer w/auto-scaling and VPN IPSec BGP ECMP deployment options
9798
- Protects Accelerator deployed and managed objects
9899
- Sets Up SNS Alerting topics (High, Medium, Low, Blackhole priorities)
99100
- Deploys CloudWatch Log Metrics and Alarms
100-
- Deploys customer provided custom config rules (2 provided out-of-box, No EC2 Instance Profile)
101+
- Deploys customer provided custom config rules (2 provided out-of-box, no EC2 Instance Profile/Permissions)
101102

102103
### 1.2.7. Centralized Logging and Alerting
103104

@@ -113,19 +114,20 @@ Specifically the accelerator deploys and manages the following functionality, bo
113114
- GuardDuty Findings
114115
- Macie Discovery results
115116
- ALB Logs
116-
- SSM Inventory **(NEW)**
117-
- Security Hub findings **(NEW)**
117+
- SSM Inventory
118+
- Security Hub findings
118119
- SSM Session Logs (also sent to CWL)
119120
- Resolver Query Logs (also sent to CWL)
120-
- Email alerting for CloudTrail Metric Alarms, Firewall Manager Events **(NEW)**, Security Hub Findings incl. Guardduty Findings **(NEW)**
121+
- Email alerting for CloudTrail Metric Alarms, Firewall Manager Events, Security Hub Findings incl. GuardDuty Findings
122+
- **NEW** Optionally collect Organization and ASEA configuration and metadata in a new restricted log archive bucket
121123

122124
## 1.3. Relationship with AWS Landing Zone Solution (ALZ)
123125

124126
The ALZ was an AWS Solution designed to deploy a multi-account AWS architecture for customers based on best practices and lessons learned from some of AWS' largest customers. The AWS Accelerator draws on design patterns from the Landing Zone, and re-uses several concepts and nomenclature, but it is not directly derived from it, nor does it leverage any code from the ALZ. The Accelerator is a standalone solution with no dependence on ALZ.
125127

126128
## 1.4. Relationship with AWS Control Tower
127129

128-
The AWS Secure Environment Accelerator now leverages AWS Control Tower! **(NEW)**
130+
The AWS Secure Environment Accelerator now leverages AWS Control Tower!
129131

130132
With the release of v1.5.0, the AWS Accelerator adds the capability to be deployed on top of AWS Control Tower. Customers get the benefits of the fully managed capabilities of AWS Control Tower combined with the power and flexibility of the Accelerators Networking and Security orchestration.
131133

src/mkdocs/docs/installation/install.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ These installation instructions assume one of the prescribed architectures is be
1515
- Management or root AWS Organization account (the AWS Accelerator cannot be deployed in an AWS sub-account)
1616
- No additional AWS accounts need to be pre-created before Accelerator installation
1717
- If required, a limit increase to support your desired number of new AWS sub-accounts (default limit is 10 sub-accounts)
18-
- **recent changes to new AWS account limits are causing accelerator installation failures, please work with your local account team to increase your limits**
18+
- **recent changes to new AWS account limits are causing accelerator installation failures, please work with your local account team to increase your limits**
1919
- Valid Accelerator configuration file, updated to reflect your requirements (see below)
2020
- Determine your primary or Accelerator `control` or `home` region, this is the AWS region in which you will most often operate
2121
- Government of Canada customers are still required to do a standalone installation at this time, please request standalone installation instructions from your Account SA or TAM
@@ -142,7 +142,8 @@ Before installing, you must first:
142142
- OU and account names can ONLY be customized during initial installation. These values MUST match with the values supplied in the Accelerator config file.
143143
1. Go to the AWS Control Tower console and click `Set up landing zone`
144144
2. Select your `home` region (i.e. `ca-central-1`) - the Accelerator home region must match the Control Tower home region
145-
3. Select _all_ regions for `Additional AWS Regions for governance`, click `Next`
145+
3. Leave the Region deny setting set to `Not enabled` - the Accelerator needs a customized region deny policy
146+
4. Select _all_ regions for `Additional AWS Regions for governance`, click `Next`
146147
- The Control Tower and Accelerator regions MUST be properly aligned
147148
- If a region is not `governed` by Control Tower, it must NOT be listed in `control-tower-supported-regions`
148149
- To manage a region requires the region:
@@ -152,15 +153,16 @@ Before installing, you must first:
152153
- While we highly recommend guardrail deployment for all AWS enabled by default regions, at minimum
153154
- the home region MUST be enabled in Control Tower and must be listed in `control-tower-supported-regions`
154155
- both the home-region and ${GBL\*REGION} must be listed in `supported-regions`
155-
4. For the `Foundational OU`, leave the default value `Security`
156-
5. For the `Additional OU` provide the value `Infrastructure`, click `Next`
157-
6. Enter the email addresses for your `Log Archive` and `Audit` accounts, change the `Audit` account name to `Security`, click `Next` - OU and account names can ONLY be customized during initial installation. OU names, account names and email addresses \_must\* match identically with the values supplied in the Accelerator config file.
158-
7. Click setup and wait ~60 minutes for the Control Tower installation to complete
159-
8. Select `Add or register organizational units`, Click `Add an OU`
160-
9. Type `Dev`, click `Add`, wait until the OU is finished provisioning (or it will error)
161-
10. Repeat step 9 for each OU (i.e. `Test`, `Prod`, `Central`, `Sandbox`)
162-
11. Select `Account factory`, Edit, Subnets: 0, Deselect all regions, click `Save`
163-
12. In AWS Organizations, move the Management account from the `root` OU into the `Security` OU
156+
5. For the `Foundational OU`, leave the default value `Security`
157+
6. For the `Additional OU` provide the value `Infrastructure`, click `Next`
158+
7. Enter the email addresses for your `Log Archive` and `Audit` accounts, change the `Audit` account name to `Security`, click `Next` - OU and account names can ONLY be customized during initial installation. OU names, account names and email addresses \_must\* match identically with the values supplied in the Accelerator config file.
159+
8. Select `Enabled` for AWS CloudTrail configuration (if not selected), click `Next`
160+
9. Click `Set up landing zone` and wait ~60 minutes for the Control Tower installation to complete
161+
10. Select `Add or register organizational units`, Click `Add an OU`
162+
11. Type `Dev`, click `Add`, wait until the OU is finished provisioning (or it will error)
163+
12. Repeat step 9 for each OU (i.e. `Test`, `Prod`, `Central`, `Sandbox`)
164+
13. Select `Account factory`, Edit, Subnets: 0, Deselect all regions, click `Save`
165+
14. In AWS Organizations, move the Management account from the `root` OU into the `Security` OU
164166
4. Verify:
165167
1. AWS Organizations is enabled in `All features` mode
166168
- if required, navigate to AWS Organizations, click `Create Organization`, `Create Organization`
@@ -365,9 +367,17 @@ If deploying to an internal AWS employee account and installing the solution wit
365367

366368
Current Issues:
367369

370+
- **NEW 2022-08-07** An issue with the version of cfn-init in the "latest" AWS standard Windows AMI will cause the state machine to fail during a new installation when deploying an RDGW host. RDGW hosts in existing deployments will fail to fully initialize if the state machine is or has been recently run and the auto-scaling group subsequently refreshes the host (default every 7 days).
371+
372+
- To temporarily workaround this issue, assume an administrative role in your `operations` account, open Systems Manager Parameter Store, and `Create parameter` with a Name of `/asea/windows-ami` and a value of `ami-0d336ea070bc06fb8` (which is the previous good AMI), accepting the other default values. Update your config file to point to this new parameter by changing `image-path` (under \deployments\mad) to `/asea/windows-ami` instead of `/aws/service/ami-windows-latest/Windows_Server-2016-English-Full-Base`. Rerun your state machine. If you have an existing RDGW instance it should be terminated to allow the auto-scaling group to redeploy it.
373+
- This config file entry should be reverted and state machine rerun once the next AWS Windows AMI is released (hopefully within the next week) to ensure you are always using the latest Windows AMI.
374+
368375
- If dns-resolver-logging is enabled, VPC names containing spaces are not supported at this time as the VPC name is used as part of the log group name and spaces are not supported in log group names. By default in many of the sample config files, the VPC name is auto-generated from the OU name using a variable. In this situation, spaces are also not permitted in OU names (i.e. if any account in the OU has a VPC with resolver logging enabled and the VPC is using the OU as part of its name)
376+
369377
- On larger deployments we are occasionally seeing state machine failures when `Creating Config Recorders`. Simply rerun the state machine with the input of `{"scope": "FULL", "mode": "APPLY"}`.
378+
370379
- Occasionally CloudFormation fails to return a completion signal. After the credentials eventually fail (1 hr), the state machine fails. Simply rerun the state machine with the input of `{"scope": "FULL", "mode": "APPLY"}`
380+
371381
- If the State Machine fails on an initial execution of NEW-ACCOUNTS, it must be re-run to target the failed accounts (i.e. with `{"scope": "FULL", "mode": "APPLY"}`) or the new sub-accounts will fail to be properly guardrailed
372382

373383
Issues in Older Releases:

0 commit comments

Comments
 (0)