Skip to content

Commit b272299

Browse files
authored
(docs) Enhance multiple documents (FAQ, Installation, readme, Ops, index) (#551)
* (docs) enhancements - match MAD and IAM password policies in config files - remove FWMgr from Full sample PBMM config file - move Accelerator release process to separate file - move config file customization information to config file customization page/file - move FAQ to separate file - enhance install doc - add details to root password recovery - add MFA details - minor enhancements readme, index - add 4 more answers to Q&A/Operations Info - remove no longer relevant upgrade information for old versions - add Joel's FAQ's/update Ops guide with answer 5. - add another Q&A
1 parent 3ad41ad commit b272299

File tree

10 files changed

+466
-334
lines changed

10 files changed

+466
-334
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
3232

3333
### Creates Networking
3434

35-
- Transit Gateways and TGW route tables (incl. inter-region peering)
35+
- Transit Gateways and TGW route tables (incl. inter-region TGW peering)
3636
- Centralized and/or Local (bespoke) VPC's
3737
- Subnets, Route tables, NACLs, Security groups, NATGWs, IGWs, VGWs, CGWs
3838
- VPC Endpoints (Gateway and Interface, Centralized or Local)
@@ -49,7 +49,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
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
52+
- Deploy and share SSM documents (2 provided out-of-box, ELB & S3 remediation)
5353

5454
### Identity
5555

@@ -69,7 +69,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
6969
- Firewall Manager
7070
- CloudTrail w/Insights and S3 data plane logging
7171
- Config Recorders/Aggregator
72-
- Config rules
72+
- Config rules (95 out-of-box NIST 800-53 rules, customizable per OU)
7373
- Macie
7474
- IAM Access Analyzer
7575
- CloudWatch access from central designated admin account (and setting Log group retentions)
@@ -107,9 +107,9 @@ Specifically the accelerator deploys and manages the following functionality, bo
107107

108108
## Relationship with AWS Landing Zone Solution (ALZ)
109109

110-
The ALZ is 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.
110+
The ALZ is 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 initial versions of the AWS Accelerator presupposed the existence of an AWS Landing Zone Solution in the AWS Organization; this requirement has since been removed as of release `v1.1.0`.
111111

112-
The initial versions of the AWS Accelerator presupposed the existence of an AWS Landing Zone Solution in the AWS Organization; this requirement has since been removed as of release `v1.1.0`. The Accelerator is now a completely standalone solution.
112+
The Accelerator is now a completely standalone solution.
113113

114114
## Relationship with AWS Control Tower
115115

@@ -127,7 +127,7 @@ This summarizes the installation process, the full installation document can be
127127
- Download and execute the latest installer CloudFormation template in your root accounts preferred 'primary' region
128128
- Wait for:
129129
- CloudFormation to deploy and start the Code Pipeline (~5 mins)
130-
- Code Pipeline to download the Accelerator codebase and install the Accelerator State Machine (~15-20 mins)
130+
- Code Pipeline to download the Accelerator codebase and install the Accelerator State Machine (~20 mins)
131131
- The Accelerator State Machine to finish execution (~1.5 hrs)
132132
- Perform required manual follow-up activities (configure AWS SSO, set firewall passwords, etc.)
133133
- When required:
@@ -138,27 +138,27 @@ This summarizes the installation process, the full installation document can be
138138

139139
# **Documentation**
140140

141-
### - [Installation, Upgrades and Basic Operations Guide](./docs/installation/installation.md)
141+
### - Accelerator Installation and Upgrade [Guide](./docs/installation/installation.md)
142142

143-
- Link to [releases](https://github.com/aws-samples/aws-secure-environment-accelerator/releases)
144-
- [Link](./docs/installation/customization-index.md) to sample config files and customization details
145-
- More [details](./docs/installation/what-we-do-where.md) as to WHAT we do and WHERE we support it (regions, accounts, etc.)
146-
- AWS SEA Central Logging [Bucket Structures](./docs/architectures/pbmm/log-file-locations.md)
147-
- Unofficial [Roadmap](https://github.com/aws-samples/aws-secure-environment-accelerator/projects)
143+
- Link to Accelerator [releases](https://github.com/aws-samples/aws-secure-environment-accelerator/releases) and change history
144+
- Sample configuration files and customization [details](./docs/installation/customization-index.md)
145+
- [Chart](./docs/installation/what-we-do-where.md) containing details as to WHAT we do and WHERE we support it (regions, accounts, etc.)
146+
- Accelerator central logging [bucket structures](./docs/architectures/pbmm/log-file-locations.md)
147+
- Unofficial Accelerator [Roadmap](https://github.com/aws-samples/aws-secure-environment-accelerator/projects) (GitHub projects) - _Please upvote desired features_
148148

149-
### - [Accelerator Operations/Troubleshooting Guide](./docs/operations/operations-troubleshooting-guide.md)
149+
### - Accelerator Operations/Troubleshooting [Guide](./docs/operations/operations-troubleshooting-guide.md)
150150

151-
### - [Accelerator Developer Guide](./docs/developer/developer-guide.md)
151+
### - Accelerator Basic Operation and Frequently Asked Questions [(FAQ)](./docs/faq/faq.md)
152152

153-
### - [Contributing & Governance Guide](./CONTRIBUTING.md)
153+
### - Accelerator Developer [Guide](./docs/developer/developer-guide.md)
154154

155-
### - [Prescriptive PBMM Architecture Design Document](./docs/architectures/pbmm/architecture.md) (Early Draft)
155+
- Accelerator release [process](./docs/developer/release-process.md) (AWS Internal)
156156

157-
- AWS PBMM Architecture Sample [Diagrams](./docs/architectures/pbmm/AWS_PBMM_Accel_Account_Network_VPC.md)
157+
### - Contributing & Governance [Guide](./CONTRIBUTING.md)
158158

159-
### - Frequently Asked Questions
159+
### - Prescriptive PBMM Architecture Design [Document](./docs/architectures/pbmm/architecture.md) (Early Draft)
160160

161-
- See section 3. of the Accelerator Installation, Upgrades and Basic Operations Guide
161+
- AWS PBMM architecture sample [diagrams](./docs/architectures/pbmm/AWS_PBMM_Accel_Account_Network_VPC.md)
162162

163163
---
164164

docs/developer/release-process.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AWS Internal - Accelerator Release Process
2+
3+
## Creating a new Accelerator Code Release
4+
5+
1. Ensure `master` branch is in a suitable state
6+
2. Disable branch protection for both the `master` branch and for the `release/` branches
7+
3. Create a version branch with [SemVer](https://semver.org/) semantics and a `release/` prefix: e.g. `release/v1.0.5` or `release/v1.0.5-b`
8+
9+
- On latest `master`, run: `git checkout -b release/vX.Y.Z`
10+
- **Important:** Certain git operations are ambiguous if tags and branches have the same name. Using the `release/` prefix reserves the actual version name for the tag itself; i.e. every `release/vX.Y.Z` branch will have a corresponding `vX.Y.Z` tag.
11+
12+
4. Push that branch to GitHub (if created locally)
13+
14+
- `git push origin release/vX.Y.Z`
15+
16+
5. The release workflow will run, and create a **DRAFT** release if successful with all commits since the last tagged release.
17+
6. Prune the commits that have been added to the release notes (e.g. remove any low-information commits)
18+
7. Publish the release - this creates the git tag in the repo and marks the release as latest. It also bumps the `version` key in several project `package.json` files.
19+
8. Re-enable branch protection for both the `master` branch and for the `release/` branches
20+
21+
- Note: The `Publish` operation will run [the following GitHub Action][action], which merges the `release/vX.Y.Z` branch to `master`. **Branch Protection in GitHub will cause this to fail**, and why we are momentarily disabling branch protection.
22+
23+
[action]: https://github.com/aws-samples/aws-secure-environment-accelerator/blob/master/.github/workflows/publish.yml
24+
25+
9. A successful run of this workflow will automatically kick off the "Generate Documentation" workflow. This workflow may also be initiated at any time manually via the GitHub Actions UI (since it is configured as a `workflow_dispatch` action).
26+
27+
- once the documentaion is generated, add them to the release assets
28+
29+
10. Finally rename the `AcceleratorInstaller.template.json` to `AcceleratorInstaller`XXX`.template.json` replacing XXX with the version number without punctuation (i.e. `AcceleratorInstaller121b.template.json`)
30+
31+
---
32+
33+
[...Return to Accelerator Table of Contents](../index.md)

0 commit comments

Comments
 (0)