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
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,9 +120,11 @@ Before installing, you must first:
120
120
121
121
1. Login to the Organization **Management or root AWS account** with `AdministratorAccess`.
122
122
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`
124
125
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)
126
128
6. Ensure `alz-baseline=false` is set in the configuration file
127
129
7. Create a new KMS key to encrypt your source configuration bucket (you can use an existing key)
128
130
@@ -154,8 +156,8 @@ Before installing, you must first:
154
156
4. Store the personal access token in Secrets Manager as plain text. Name the secret `accelerator/github-token` (case sensitive).
155
157
- Via AWS console
156
158
- 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`),
159
161
- Set the secret name to `accelerator/github-token` (case sensitive)
160
162
- Select `Disable rotation`
161
163
@@ -195,7 +197,7 @@ If deploying to an internal AWS account, to successfully install the entire solu
195
197
4. When updating the budget notification email addresses within the example, a single email address for all is sufficient;
196
198
5. For a test deployment, the remainder of the values can be used as-is.
197
199
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).
199
201
4. When deploying to regions other than ca-central-1, you need to:
200
202
1. Replace all occurences of ca-central-1 in the config file with your home region
201
203
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
227
229
## 2.5. Installation
228
230
229
231
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
231
233
3. Use the provided CloudFormation template to deploy a new stack in your AWS account
232
234
4.**_Make sure you are in `ca-central-1` (or your desired primary or control region)_**
233
235
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
241
243
11.**ENABLE STACK TERMINATION PROTECTION** under `Stack creation options`
242
244
12. The stack typically takes under 5 minutes to deploy.
243
245
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.
244
247
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.
245
248
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**
246
249
16. Once the pipeline completes (typically 15-20 minutes), the main state machine, named `PBMMAccel-MainStateMachine_sm`, will start in Step Functions
Copy file name to clipboardExpand all lines: reference-artifacts/Custom-Scripts/SEA-uninstall/README.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,22 +73,30 @@ The logic of the script is the following:
73
73
3. Before running this script you must manually delete AWS SSO.
74
74
75
75
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`.
77
81
78
82
## Considerations
79
83
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:
81
85
82
86
a. Certificates in ACM
83
87
84
-
b. The initial bootstrap CloudFormation Stack
88
+
b. The initial CDK bootstrap CloudFormation Stack (`CDKToolkit`)
85
89
86
-
c. CDK S3 buckets
90
+
c. CDK S3 buckets (`cdktoolkit-stagingbucket-*`)
87
91
88
-
d. Secret Keys
92
+
d. Secrets Manager Secrets
89
93
90
94
e. Does not recreate Default VPCs
91
95
96
+
f. KMS keys
97
+
98
+
g. ECR repository `aws-cdk/assets`
99
+
92
100
2. If redeploying the accelerator in AWS Accounts after having ran this script. Note the following:
93
101
94
102
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:
97
105
98
106
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.
99
107
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.
Copy file name to clipboardExpand all lines: reference-artifacts/config.ALZ.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -421,7 +421,7 @@
421
421
"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)."
422
422
},
423
423
{
424
-
"alarm-name": "AWS-ClouadTrail-Changed",
424
+
"alarm-name": "AWS-CloudTrail-Changed",
425
425
"metric-name": "CloudTrailEventCount",
426
426
"sns-alert-level": "High",
427
427
"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)."
Copy file name to clipboardExpand all lines: reference-artifacts/config.example.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -418,7 +418,7 @@
418
418
"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)."
419
419
},
420
420
{
421
-
"alarm-name": "AWS-ClouadTrail-Changed",
421
+
"alarm-name": "AWS-CloudTrail-Changed",
422
422
"metric-name": "CloudTrailEventCount",
423
423
"sns-alert-level": "High",
424
424
"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)."
Copy file name to clipboardExpand all lines: reference-artifacts/config.lite-example.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -418,7 +418,7 @@
418
418
"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)."
419
419
},
420
420
{
421
-
"alarm-name": "AWS-ClouadTrail-Changed",
421
+
"alarm-name": "AWS-CloudTrail-Changed",
422
422
"metric-name": "CloudTrailEventCount",
423
423
"sns-alert-level": "High",
424
424
"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