Skip to content

Commit b77ff3c

Browse files
authored
(docs) Fix Typos and make minor enhancements (#525)
- config files - installation doc - uninstall script - sample snippets
1 parent 5bb589a commit b77ff3c

File tree

6 files changed

+28
-15
lines changed

6 files changed

+28
-15
lines changed

docs/installation/installation.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,11 @@ Before installing, you must first:
120120

121121
1. Login to the Organization **Management or root AWS account** with `AdministratorAccess`.
122122
2. **_Set the region to `ca-central-1`._**
123-
3. Enable AWS Organizations
123+
3. Enable AWS Organizations in `All features` mode
124+
- Navigate to AWS Organizations, click `Create Organization`, `Create Organization`
124125
4. Enable Service Control Policies
125-
5. In AWS Organizations, ["Verify"](https://aws.amazon.com/blogs/security/aws-organizations-now-requires-email-address-verification/) the Organization Management (root) account email address (this is a technical process)
126+
- In Organizations, select `Policies`, `Service control policies`, `Enable service control policies`
127+
5. In AWS Organizations, Settings, ["Send Verification Request"](https://aws.amazon.com/blogs/security/aws-organizations-now-requires-email-address-verification/) the Organization Management (root) account email address (this is a technical process)
126128
6. Ensure `alz-baseline=false` is set in the configuration file
127129
7. Create a new KMS key to encrypt your source configuration bucket (you can use an existing key)
128130

@@ -154,8 +156,8 @@ Before installing, you must first:
154156
4. Store the personal access token in Secrets Manager as plain text. Name the secret `accelerator/github-token` (case sensitive).
155157
- Via AWS console
156158
- Store a new secret, and select `Other type of secrets`, `Plaintext`
157-
- Paste your secret with no formatting no leading or trailing spaces
158-
- Select either the key you created above (`PBMMAccel-Source-Bucket-Key`),
159+
- Paste your secret with no formatting no leading or trailing spaces (i.e. completely remove the example text)
160+
- Select the key you created above (`PBMMAccel-Source-Bucket-Key`),
159161
- Set the secret name to `accelerator/github-token` (case sensitive)
160162
- Select `Disable rotation`
161163

@@ -195,7 +197,7 @@ If deploying to an internal AWS account, to successfully install the entire solu
195197
4. When updating the budget notification email addresses within the example, a single email address for all is sufficient;
196198
5. For a test deployment, the remainder of the values can be used as-is.
197199

198-
3. A successful deployment requires VPC access to 6 AWS endpoints, you cannot remove both the perimeter firewalls (all public endpoints) and the 6 required central VPC endpoints from the config file (ec2, ec2messages, ssm, ssmmessages, cloudformation, secretsmanager).
200+
3. A successful deployment requires VPC access to 6 AWS endpoints, you cannot remove both the perimeter firewalls (all public endpoints) and the 7 required central VPC endpoints from the config file (ec2, ec2messages, ssm, ssmmessages, cloudformation, secretsmanager, kms).
199201
4. When deploying to regions other than ca-central-1, you need to:
200202
1. Replace all occurences of ca-central-1 in the config file with your home region
201203
2. Update the firewall and firewall manager AMI id's to reflect your home regions regional AMI id's (see 1.1.3, item 10) Make sure you select the right version, v6.2.3 is recommended at this time.
@@ -227,7 +229,7 @@ If deploying to an internal AWS account, to successfully install the entire solu
227229
## 2.5. Installation
228230

229231
1. You can find the latest release in the repository [here](https://github.com/aws-samples/aws-secure-environment-accelerator/releases).
230-
2. Download the CloudFormation template `AcceleratorInstallerXXX.template.json` for the release you plan to install
232+
2. Download the CloudFormation (CFN) template `AcceleratorInstallerXXX.template.json` for the release you plan to install
231233
3. Use the provided CloudFormation template to deploy a new stack in your AWS account
232234
4. **_Make sure you are in `ca-central-1` (or your desired primary or control region)_**
233235
5. Fill out the required parameters - **_LEAVE THE DEFAULTS UNLESS SPECIFIED BELOW_**
@@ -241,6 +243,7 @@ If deploying to an internal AWS account, to successfully install the entire solu
241243
11. **ENABLE STACK TERMINATION PROTECTION** under `Stack creation options`
242244
12. The stack typically takes under 5 minutes to deploy.
243245
13. Once deployed, you should see a CodePipeline project named `PBMMAccel-InstallerPipeline` in your account. This pipeline connects to Github, pulls the code from the prescribed branch and deploys the Accelerator state machine.
246+
- if the pipeline fails connecting to GitHub, fix the issue with your GitHub secret created in section 2.3.2, then delete the Installer CloudFormation stack you just deployed, and restart at step 3 of this section.
244247
14. For new stack deployments, when the stack deployment completes, the Accelerator state machine will automatically execute (in Code Pipeline). When upgrading you must manually `Release Change` to start the pipeline.
245248
15. **While the pipeline is running, review the list of [Known Installation Issues]([https://github.com/aws-samples/aws-secure-environment-accelerator/blob/master/docs/installation/index.md#Known-Installation-Issues) near the bottom on this document**
246249
16. Once the pipeline completes (typically 15-20 minutes), the main state machine, named `PBMMAccel-MainStateMachine_sm`, will start in Step Functions

reference-artifacts/Custom-Scripts/SEA-uninstall/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,30 @@ The logic of the script is the following:
7373
3. Before running this script you must manually delete AWS SSO.
7474

7575
4. Execute the script `python3 aws-sea-cleanup.py`
76-
5. In Secrets Manager set the Secret `accelerator/config/last-successful-commit` to an empty string.
76+
5. Manual steps (in the Organization Management account):
77+
- In Secrets Manager, set the Secret `accelerator/config/last-successful-commit` to an empty string;
78+
- In DynamoDB, delete the 3 `PBMMAccel-*` tables;
79+
- In Systems Manager Parameter Store, delete the `/accelerator/version` parameter;
80+
- In CodeCommit, delete the repository `PBMMAccel-Config-Repo`.
7781

7882
## Considerations
7983

80-
1. Not all resources are currently cleaned up. Here is a list of what is known:
84+
1. Additional known resources not currently cleaned up:
8185

8286
a. Certificates in ACM
8387

84-
b. The initial bootstrap CloudFormation Stack
88+
b. The initial CDK bootstrap CloudFormation Stack (`CDKToolkit`)
8589

86-
c. CDK S3 buckets
90+
c. CDK S3 buckets (`cdktoolkit-stagingbucket-*`)
8791

88-
d. Secret Keys
92+
d. Secrets Manager Secrets
8993

9094
e. Does not recreate Default VPCs
9195

96+
f. KMS keys
97+
98+
g. ECR repository `aws-cdk/assets`
99+
92100
2. If redeploying the accelerator in AWS Accounts after having ran this script. Note the following:
93101

94102
a. Re-populate the original S3 config bucket and delete the CodeCommit repository
@@ -97,6 +105,8 @@ The logic of the script is the following:
97105

98106
c. GuardDuty and/or Macie will likely fail during a Phase deployment. If that happens, access the Security account and invite all accounts as members in all regions. Some accounts may be listed as non-members.
99107

108+
d. If you accidentally delete a cdk bucket (`cdktoolkit-stagingbucket-*`) in any region, you MUST remove the corresponding CDK bootstrap stack (`CDKToolkit`) from the corresponding regions before deploying.
109+
100110
## Requirements
101111

102112
- boto3

reference-artifacts/config-sample-snippets/sample_snippets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
- Valid options for vpc flow logs setting on each VPC
3636

3737
```
38-
"flow-logs": "S3" ---> S3, CWL, BOTH
38+
"flow-logs": "S3" ---> S3, CWL, BOTH, NONE
3939
```
4040

4141
---

reference-artifacts/config.ALZ.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@
421421
"alarm-description": "Alarms when one or more API calls are made to create, terminate, start, stop or reboot a 4x, 8x, 9x, 10x, 12x, 16x, 18x, 24x, 32x-large EC2 instance (in any account, any region of your AWS Organization)."
422422
},
423423
{
424-
"alarm-name": "AWS-ClouadTrail-Changed",
424+
"alarm-name": "AWS-CloudTrail-Changed",
425425
"metric-name": "CloudTrailEventCount",
426426
"sns-alert-level": "High",
427427
"alarm-description": "Alarms when one or more API calls are made to create, update or delete a CloudTrail trail, or to start or stop logging to a trail (in any account, any region of your AWS Organization)."

reference-artifacts/config.example.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@
418418
"alarm-description": "Alarms when one or more API calls are made to create, terminate, start, stop or reboot a 4x, 8x, 9x, 10x, 12x, 16x, 18x, 24x, 32x-large EC2 instance (in any account, any region of your AWS Organization)."
419419
},
420420
{
421-
"alarm-name": "AWS-ClouadTrail-Changed",
421+
"alarm-name": "AWS-CloudTrail-Changed",
422422
"metric-name": "CloudTrailEventCount",
423423
"sns-alert-level": "High",
424424
"alarm-description": "Alarms when one or more API calls are made to create, update or delete a CloudTrail trail, or to start or stop logging to a trail (in any account, any region of your AWS Organization)."

reference-artifacts/config.lite-example.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@
418418
"alarm-description": "Alarms when one or more API calls are made to create, terminate, start, stop or reboot a 4x, 8x, 9x, 10x, 12x, 16x, 18x, 24x, 32x-large EC2 instance (in any account, any region of your AWS Organization)."
419419
},
420420
{
421-
"alarm-name": "AWS-ClouadTrail-Changed",
421+
"alarm-name": "AWS-CloudTrail-Changed",
422422
"metric-name": "CloudTrailEventCount",
423423
"sns-alert-level": "High",
424424
"alarm-description": "Alarms when one or more API calls are made to create, update or delete a CloudTrail trail, or to start or stop logging to a trail (in any account, any region of your AWS Organization)."

0 commit comments

Comments
 (0)