Skip to content

Commit df93ddc

Browse files
authored
Doc updates v1.3.0, SCP FIX (#661)
* (docs)spelling, minor updates 1.3.0 * fixSCP
1 parent 19e18f2 commit df93ddc

File tree

8 files changed

+63
-60
lines changed

8 files changed

+63
-60
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,14 @@ Specifically the accelerator deploys and manages the following functionality, bo
4343

4444
### Cross-Account Object Sharing
4545

46-
- VPC and Subnet sharing, including account level retagging (Per account security group 'replication')
46+
- VPC and Subnet sharing, including account level re-tagging (Per account security group 'replication')
4747
- VPC attachments and peering (local and cross-account)
4848
- Zone sharing and VPC associations
4949
- Managed Active Directory sharing, including R53 DNS resolver rule creation/sharing
5050
- Automated TGW inter-region peering
5151
- Populate Parameter Store with all `user` objects to be used by customers' IaC
52-
- Deploy and share SSM documents (2 provided out-of-box, ELB & S3 remediation)
52+
- Deploy and share SSM documents (3 provided out-of-box, ELB Logging, S3 Encryption, and Instance Profile remediation)
53+
- customer can provide their own SSM documents for automated deployment and sharing
5354

5455
### Identity
5556

@@ -69,7 +70,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
6970
- Firewall Manager
7071
- CloudTrail w/Insights and S3 data plane logging
7172
- Config Recorders/Aggregator
72-
- Config rules (95 out-of-box NIST 800-53 rules, customizable per OU)
73+
- Conformance Packs and Config rules (95 out-of-box NIST 800-53 rules, customizable per OU)
7374
- Macie
7475
- IAM Access Analyzer
7576
- CloudWatch access from central designated admin account (and setting Log group retentions)
@@ -87,6 +88,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
8788
- Protects Accelerator deployed and managed objects
8889
- Sets Up SNS Alerting topics (High, Medium, Low, Blackhole priorities)
8990
- Deploys CloudWatch Log Metrics and Alarms
91+
- Deploys customer provided custom config rules (1 provided out-of-box, No EC2 Instance Profile)
9092

9193
### Centralized Logging and Alerting
9294

@@ -121,17 +123,17 @@ When appropriate, it is envisioned that the AWS Accelerator will add the capabil
121123

122124
This summarizes the installation process, the full installation document can be found in the documentation section below.
123125

124-
- Create a config.json (or config.yaml) file to represent your organizations requirements (PBMM sample provided)
126+
- Create a config.json (or config.yaml) file to represent your organizations requirements (several samples provided)
125127
- Create a Secrets Manager Secret which contains a GitHub token that provides access to the Accelerator code repo
126128
- Create a unique S3 input bucket and place your config.json and any additional custom config files in the bucket
127-
- Download and execute the latest installer CloudFormation template in your root accounts preferred 'primary' region
129+
- Download and execute the latest installer CloudFormation template in your root accounts preferred 'primary' / 'home' region
128130
- Wait for:
129131
- CloudFormation to deploy and start the Code Pipeline (~5 mins)
130132
- Code Pipeline to download the Accelerator codebase and install the Accelerator State Machine (~20 mins)
131133
- The Accelerator State Machine to finish execution (~1.5 hrs)
132134
- Perform required manual follow-up activities (configure AWS SSO, set firewall passwords, etc.)
133135
- When required:
134-
- Use AWS Organizations to create new fully managed and guardrailed AWS accounts
136+
- Use AWS Organizations to create new AWS accounts, which will automatically be guardrailed by the Accelerator
135137
- Update the config file in CodeCommit and run the Accelerator State Machine (~25 min) to:
136138
- deploy, configure and guardrail multiple accounts at the same time
137139
- change Accelerator configuration settings

docs/faq/faq.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- [1.1.5. What if I really mess up the configuration file?](#115-what-if-i-really-mess-up-the-configuration-file)
1010
- [1.1.6. What if my State Machine fails? Why? Previous solutions had complex recovery processes, what's involved?](#116-what-if-my-state-machine-fails-why-previous-solutions-had-complex-recovery-processes-whats-involved)
1111
- [1.1.7. How do I update some of the supplied sample configuration items found in reference-artifact, like SCPs and IAM policies?](#117-how-do-i-update-some-of-the-supplied-sample-configuration-items-found-in-reference-artifact-like-scps-and-iam-policies)
12-
- [1.1.8. I deployed AWS Managed Active Directory (MAD) as part of my depoloyment, how do I manage Active Directory domain users, groups, and domain policies after deployment?](#118-i-deployed-aws-managed-active-directory-mad-as-part-of-my-depoloyment-how-do-i-manage-active-directory-domain-users-groups-and-domain-policies-after-deployment)
12+
- [1.1.8. I deployed AWS Managed Active Directory (MAD) as part of my deployment, how do I manage Active Directory domain users, groups, and domain policies after deployment?](#118-i-deployed-aws-managed-active-directory-mad-as-part-of-my-deployment-how-do-i-manage-active-directory-domain-users-groups-and-domain-policies-after-deployment)
1313
- [1.1.9. How do I suspend an AWS account?](#119-how-do-i-suspend-an-aws-account)
1414
- [1.1.10. I need a new VPC, where shall I define it?](#1110-i-need-a-new-vpc-where-shall-i-define-it)
1515
- [1.1.11. How do I modify and extend the Accelerator or execute my own code after the Accelerator provisions a new AWS account or the state machine executes?](#1111-how-do-i-modify-and-extend-the-accelerator-or-execute-my-own-code-after-the-accelerator-provisions-a-new-aws-account-or-the-state-machine-executes)
@@ -125,9 +125,9 @@ Customers can also define additional SCPs (or modify existing SCPs) using the na
125125

126126
Prior to v1.2.5, if we updated the default files, we overwrote customers customizations during upgrade. Simply updating the timestamp _after_ upgrade on the customized versions and then rerunning the state machine re-instates customer customizations. In v1.2.5 we always use the customer customized version from the S3 bucket. It's important customers assess newly provided defaults during an upgrade process to ensure they are incorporating all the latest fixes and improvements. If a customer wants to revert to Accelerator provided default files, they will need to manually copy it from the repo into their input bucket.
127127

128-
NOTE: Most of the provided SCPs are designed to protect the Accelerator deployed resources from modification and ensure the integrity of the Accelerator. Extreme caution must be excercised if the provided SCPs are modified. We will be improving documenation as to which SCPs deliver security functionality versus those protecting the Accelerator itself in a future release.
128+
NOTE: Most of the provided SCPs are designed to protect the Accelerator deployed resources from modification and ensure the integrity of the Accelerator. Extreme caution must be exercised if the provided SCPs are modified. We will be improving documentation as to which SCPs deliver security functionality versus those protecting the Accelerator itself in a future release.
129129

130-
### 1.1.8. I deployed AWS Managed Active Directory (MAD) as part of my depoloyment, how do I manage Active Directory domain users, groups, and domain policies after deployment?
130+
### 1.1.8. I deployed AWS Managed Active Directory (MAD) as part of my deployment, how do I manage Active Directory domain users, groups, and domain policies after deployment?
131131

132132
Customers have clearly indicated they do NOT want to use the Accelerator to manage their Active Directory domain or change the way they manage Active Directory on an ongoing basis. Customer have also indicated, they need help getting up and running quickly. For these reasons, the Accelerator only sets the domain password policy, and creates AD users and groups on the initial installation of MAD. After the initial installation, customers must manage Windows users and groups using their traditional tools. A bastion Windows host is deployed as a mechanism to support these capabilities. Passwords for all newly created MAD users have been stored, encrypted, in AWS Secrets Manager in the Management (root) Organization AWS account.
133133

@@ -155,11 +155,11 @@ The Accelerator will not create/update/delete new AD users or groups, nor will i
155155

156156
You can define a VPC in one of three major sections of the Accelerator configuration file:
157157

158-
- within an organization unit (this is the recommended and prefered method);
158+
- within an organization unit (this is the recommended and preferred method);
159159
- within an account in mandatory-account-configs;
160160
- within an account in workload-account-configs.
161161

162-
We generally recommend most items be defined within organizational units, such that all workload accounts pickup their persona from the OU they are associated and minimize per account configuration. Both a local account based VPC (as deployed in the Sandbox OU accounts), or a central VPC (as deployed in the Dev.Test/Prod OU accounts) can be defined in an OU. It should be noted that local VPC's will each be deployed with the same CIDR ranges (at this time) and therfor should not be connected to a TGW.
162+
We generally recommend most items be defined within organizational units, such that all workload accounts pickup their persona from the OU they are associated and minimize per account configuration. Both a local account based VPC (as deployed in the Sandbox OU accounts), or a central VPC (as deployed in the Dev.Test/Prod OU accounts) can be defined in an OU. It should be noted that local VPC's will each be deployed with the same CIDR ranges (at this time) and therefor should not be connected to a TGW.
163163

164164
As mandatory accounts often have unique configuration requirements, VPC's like the Endpoint VPC, are configured within the mandatory account configuration. Customers can also define VPC's within each workload account configuration, but this requires editing the configuration file for each account configuration.
165165

@@ -225,7 +225,7 @@ Objects deployed by the Accelerator which customers may need to leverage in thei
225225

226226
Objects of the following types and their associated values are stored in parameter store: vpc, subnet, security group, elb (alb/nlb w/DNS address), IAM policy, IAM role, KMS key, ACM cert, SNS topic, and the firewall replacement variables.
227227

228-
Additionally, setting "populate-all-elbs-in-param-store": true for an account will populates all Accelerator wide ELB information into paramaater store within that account. The sample PBMM configuration files set this value on the perimeter account, such that ELB information is available to configure centralized ingress capabilities.
228+
Additionally, setting "populate-all-elbs-in-param-store": true for an account will populates all Accelerator wide ELB information into parameter store within that account. The sample PBMM configuration files set this value on the perimeter account, such that ELB information is available to configure centralized ingress capabilities.
229229

230230
## 1.4. Upgrades
231231

@@ -247,13 +247,13 @@ No. Customers can choose the IaC framework or tooling of their choice. The tooli
247247

248248
The Accelerator is an open source project, should AWS stop enhancing the solution for any reason, the community has access to the full codebase, its roadmap and history. The community can enhance, update, fork and take ownership of the project, as appropriate.
249249

250-
The Accelerator is an AWS CDK based project and synthezises to native AWS CloudFormation. AWS sub-accounts simply contain native CloudFormation stacks and associated custom resources, when required. The Accelerator architecture is such that all CloudFormation stacks are native to each AWS account with no links or ties to code in other AWS accounts or even other stacks within the same AWS account. This was an important initial design decision.
250+
The Accelerator is an AWS CDK based project and synthesizes to native AWS CloudFormation. AWS sub-accounts simply contain native CloudFormation stacks and associated custom resources, when required. The Accelerator architecture is such that all CloudFormation stacks are native to each AWS account with no links or ties to code in other AWS accounts or even other stacks within the same AWS account. This was an important initial design decision.
251251

252252
The Accelerator codebase can be completely uninstalled from the organization management (root) account, without any impact to the deployed functionality or guardrails. In this situation, guardrail updates and new account provisioning reverts to a manual process. Should a customer decide they no longer wish to utilize the solution, they can remove the Accelerator codebase without any impact to deployed resources and go back to doing things natively in AWS as they did before they deployed the Accelerator. By adopting the Accelerator, customers are not locking themselves in or making a one-way door decision.
253253

254254
### 1.5.3. What level of Support will the ASEA have from AWS Support?
255255

256-
The majority of the solution leverages native AWS services which are fully supported by AWS Support. Additionally, the Accelerator is an AWS CDK based project and synthezises to native AWS CloudFormation. AWS sub-accounts simply contain native CloudFormation stacks and associated custom resources (when required). The Accelerator architecture is such that all CloudFormation stacks are native to each AWS account with no direct links or ties to code in other AWS accounts (no stacksets, no local CDK). This was an important project design decision, keeping deployed functionality in independant local CloudFormation stacks and decoupled from solution code, which allows AWS support to effectively troubleshoot and diagnose issues local to the sub-account.
256+
The majority of the solution leverages native AWS services which are fully supported by AWS Support. Additionally, the Accelerator is an AWS CDK based project and synthesizes to native AWS CloudFormation. AWS sub-accounts simply contain native CloudFormation stacks and associated custom resources (when required). The Accelerator architecture is such that all CloudFormation stacks are native to each AWS account with no direct links or ties to code in other AWS accounts (no stacksets, no local CDK). This was an important project design decision, keeping deployed functionality in independent local CloudFormation stacks and decoupled from solution code, which allows AWS support to effectively troubleshoot and diagnose issues local to the sub-account.
257257

258258
As the Accelerator also includes code, anything specifically related to the Accelerator codebase will be only supported on a "best effort" basis by AWS support, as AWS support does not support custom code. The first line of support for the codebase is typically your local AWS team (your SA, TAM, Proserve and/or AWS Partner). As an open source project, customers can file requests using GitHub Issues against the Accelerator repository or open a discussion in GitHub discussions. Most customer issues arise during installation and are related to configuration customization or during the upgrade process.
259259

@@ -276,7 +276,7 @@ The tooling was purposely built to be extremely flexible, as we realized that so
276276

277277
We are working on building a library of sample config files to support additional customer needs and better demonstrate product capabilities and different architecture patterns. In no way is it required that the prescriptive GC architecture be used or deployed. Just because we can deploy, for example, an AWS Managed Active Directory, does not mean you need to use that feature of the solution. Disabling or changing these capabilities also requires zero code changes.
278278

279-
While the prescriptive sample configuration files were originally developed based on GC requirements, they were also developed following AWS Best Practices. Additionally, many security frameworks around the world have similiar and overlapping security requirements (you can only do security so many ways). The provided architecture is applicable to many security compliance regimes around the world and not just the GC.
279+
While the prescriptive sample configuration files were originally developed based on GC requirements, they were also developed following AWS Best Practices. Additionally, many security frameworks around the world have similar and overlapping security requirements (you can only do security so many ways). The provided architecture is applicable to many security compliance regimes around the world and not just the GC.
280280

281281
## 1.6. Deployed Functionality
282282

@@ -315,7 +315,7 @@ The Accelerator provides 3 mechanisms to enable utilizing certificates with ALB'
315315
]
316316
```
317317

318-
- When using a certificate that has a certificate chain (usally this is the case when signed by a Certificate Authority with a CA Bundle)
318+
- When using a certificate that has a certificate chain (usually this is the case when signed by a Certificate Authority with a CA Bundle)
319319

320320
```json
321321
"certificates": [
@@ -395,7 +395,7 @@ The rsyslog servers are included to accept logs for appliances and third party a
395395

396396
### 1.6.5. Can you deploy the solution without Fortinet Firewall Licenses?
397397

398-
Yes, if license files are not provided, the firewalls will come up configured and route traffic, but customers will have no mechanism to manage the firewalls/change the configuration until a valid license file is added. If invalid licence files are provided, the firewalls will fail to load the provided configuration, will not enable routing, will not bring up the VPN tunnels and will not be managable. Customers will need to either remove and redeploy the firewalls, or manually configure them. If performing a test deployment, please work with your local Fortinet account team to discuss any options for temporary evaluation licenses.
398+
Yes, if license files are not provided, the firewalls will come up configured and route traffic, but customers will have no mechanism to manage the firewalls/change the configuration until a valid license file is added. If invalid licence files are provided, the firewalls will fail to load the provided configuration, will not enable routing, will not bring up the VPN tunnels and will not be manageable. Customers will need to either remove and redeploy the firewalls, or manually configure them. If performing a test deployment, please work with your local Fortinet account team to discuss any options for temporary evaluation licenses.
399399

400400
### 1.6.6. I installed additional software on my Accelerator deployed RDGW / rsyslog host, where did it go?
401401

0 commit comments

Comments
 (0)