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
Copy file name to clipboardExpand all lines: docs/installation/installation.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -217,7 +217,8 @@ If deploying to an internal AWS employee account, to successfully install the so
217
217
218
218
1. You can find the latest release in the repository [here](https://github.com/aws-samples/aws-secure-environment-accelerator/releases).
219
219
2. Download the CloudFormation (CFN) template `AcceleratorInstallerXXX.template.json` for the release you plan to install
220
-
3. Use the provided CloudFormation template to deploy a new stack in your AWS account
220
+
3. Use the provided CloudFormation template to deploy a new stack in your Management (root) AWS account
221
+
- As previously stated we do not support installation in sub-accounts
221
222
4.**_Make sure you are in `ca-central-1` (or your desired primary or control region)_**
222
223
5. Fill out the required parameters - **_LEAVE THE DEFAULTS UNLESS SPECIFIED BELOW_**
223
224
6. Specify `Stack Name` STARTING with `PBMMAccel-` (case sensitive) suggest a suffix of `deptname` or `username`
@@ -310,6 +311,12 @@ Issues in Older Releases:
310
311
## 3.1. Considerations
311
312
312
313
- Always compare your configuration file with the config file from the release you are upgrading to in order to validate new or changed parameters or changes in parameter types / formats.
314
+
- If you have customized any of the additional Accelerator provided default configuration files (SCPs, rsyslog config, ssm-documents, iam-policies, etc.):
315
+
- customers must manually merge Accelerator provided updates with your deployed customizations;
316
+
- failure to do so could result in either a) broken Accelerator functionality, or b) dropped customer guardrail enhancements;
317
+
- prior to v1.2.5, if customers don't take action, the utilized configurations will revert to the latest Accelerator provided defaults. Update the last modified date on each custom config file in your input bucket and rerun the state machine post-upgrade to re-apply customizations;
318
+
- post v1.2.5, if customers don't take action, we will continue to utilize a customers customized configurations regardless of each files timestamp;
319
+
- in both cases it is important customers assess the new defaults and integrate them into their custom configuration or it could break Accelerator functionality.
313
320
- Upgrades to `v1.2.5 and above` from `v1.2.4 and below` requires the manual removal of the `PBMMAccel-PipelineRole` StackSet before beginning your upgrade (we have eliminated all use of StackSets in this release)
314
321
- In the root AWS account, go to: CloudFormation, StackSets
315
322
- Find: `PBMMAccel-PipelineRole`, and Select the: `Stack Instances` tab
@@ -328,15 +335,13 @@ Issues in Older Releases:
328
335
1. Ensure a valid Github token is stored in secrets manager
329
336
2. Review the upgrade considerations in section 3.1.
330
337
3. Update the config file in Code Commit with new parameters and updated parameter types based on the version you are upgrading to (this is important as features are iterating rapidly)
331
-
4. If you are replacing your GitHub Token:
332
-
338
+
4. If you customized any of the other Accelerator default config files by overriding them in your S3 input bucket, merge the latest defaults with your customizations (before upgrade in v1.2.5+, after upgrade in prior releases)
339
+
5. If you are replacing your GitHub Token:
333
340
- Take note of the s3 bucket name from the stack parameters
334
341
- Delete the Installer CFN stack (`PBMMAccel-what-you-provided`)
335
342
- Redeploy the Installer CFN stack using the latest template (provide bucket name and notification email address)
336
343
- The pipeline will automatically run and trigger the upgraded state machine
337
-
338
-
5. If you are using a pre-existing GitHub token:
339
-
344
+
6. If you are using a pre-existing GitHub token:
340
345
- Update the Installer CFN stack using the latest template, providing the `GithubBranch` associated with the release (eg. `release/v1.2.3`)
341
346
- Go To Code Pipeline and Release the PBMMAccel-InstallerPipeline
0 commit comments