You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* (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
- 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
107
107
108
108
## Relationship with AWS Landing Zone Solution (ALZ)
109
109
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`.
111
111
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.
113
113
114
114
## Relationship with AWS Control Tower
115
115
@@ -127,7 +127,7 @@ This summarizes the installation process, the full installation document can be
127
127
- Download and execute the latest installer CloudFormation template in your root accounts preferred 'primary' region
128
128
- Wait for:
129
129
- 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)
131
131
- The Accelerator State Machine to finish execution (~1.5 hrs)
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.
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