Skip to content

Commit 74f8cc9

Browse files
authored
Docs(core):Minor doc and config file tweaks (#358)
* Minor doc and config file tweaks (#358)
1 parent ebcbba2 commit 74f8cc9

File tree

9 files changed

+45
-54
lines changed

9 files changed

+45
-54
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A common misconception is that the AWS Secure Environment Accelerator only deplo
1212

1313
Additionally, while the Accelerator is initially responsible for deploying a prescribed architecture, it more importantly allows for organizations to operate, evolve, and maintain their cloud architecture and security controls over time and as they grow, with mininal effort, often using native AWS tools. Customers don't have to change the way they operate in AWS.
1414

15-
Specifically the accelerator deploys and manages the following functionality, both at initial accelerator deployment and as new accounts are created, added, or onboarded:
15+
Specifically the accelerator deploys and manages the following functionality, both at initial accelerator deployment and as new accounts are created, added, or onboarded in a completely automated manner:
1616

1717
### Creates AWS Account
1818

@@ -29,7 +29,7 @@ Specifically the accelerator deploys and manages the following functionality, bo
2929

3030
### Creates Networking
3131

32-
- Transit Gateways and TGW route tables
32+
- Transit Gateways and TGW route tables (incl. inter-region peering coming in v1.1.9)
3333
- Centralized and/or Local VPC's
3434
- Subnets, Route tables, NACLs, Security groups, NATGWs, IGWs, VGWs, CGWs
3535
- VPC Endpoints (Gateway and Interface, Centralized or Local)
@@ -78,12 +78,14 @@ Specifically the accelerator deploys and manages the following functionality, bo
7878
- Deploys both perimeter and account level ALB's w/Lambda health checks, certificates and TLS policies
7979
- Deploys & configures 3rd party firewall clusters and management instances w/vendor best practices and sample security policies, w/automated TGW ECMP BGP tunnel standup
8080
- Protects Accelerator deployed and managed objects
81+
- Sets Up SNS Alerting topics (High, Medium, Low, Blockhole priorities) (coming in v1.1.9)
82+
- Deploys CloudWatch Log Metrics and Alarms (coming in v1.1.9)
8183

82-
### Centralized Logging
84+
### Centralized Logging and Alerting
8385

8486
- Deploys an rsyslog auto-scaling cluster behind an NLB, all syslogs forwarded to CWL
85-
- Centralizes logging to a single centralize S3 bucket (enables, configures and centralizes)
86-
- VPC Flow logs (Enhanced metadata fields and CWL destination coming soon)
87+
- Centralizes logging to a single centralized S3 bucket (enables, configures and centralizes)
88+
- VPC Flow logs w/Enhanced metadata fields (also sent to CWL)
8789
- Organizational Cost and Usage Reports
8890
- CloudTrail Logs including S3 Data Plane Logs (also sent to CWL)
8991
- All CloudWatch Logs (includes rsyslog logs)
@@ -113,18 +115,18 @@ When appropriate, it is envisioned that the AWS Accelerator will add the capabil
113115

114116
This summarizes the installation process, the full installation document can be found in the documentation section below.
115117

116-
- Create a config.json file to represent your organizations requirements (PBMM sample provided)
118+
- Create a config.json (or config.yaml) file to represent your organizations requirements (PBMM sample provided)
117119
- Create a Secrets Manager Secret which contains a GitHub token with access to the Accelerator code repo
118120
- Create a unique S3 input bucket and place your config.json and any additional custom config files in the bucket
119121
- Download and execute the latest installer CloudFormation template in your master accounts preferred 'primary' region
120122
- Wait for:
121123
- CloudFormation to deploy and start the Code Pipeline (~5 mins)
122-
- Code Pipeline to download the Accelerator codebase and install the Accelerator State Machine (~15 mins)
123-
- The Accelerator State Machine to finish execution (~3hrs)
124+
- Code Pipeline to download the Accelerator codebase and install the Accelerator State Machine (~15-20 mins)
125+
- The Accelerator State Machine to finish execution (~2hrs)
124126
- Perform required manual follow-up activities (configure AWS SSO, set firewall passwords, etc.)
125127
- When required:
126128
- Use AWS Organizations to create new fully managed and guardrailed AWS accounts
127-
- Update the config file in CodeCommit and run the Accelerator State Machine (~20min) to:
129+
- Update the config file in CodeCommit and run the Accelerator State Machine (~30min) to:
128130
- deploy, configure and guardrail multiple accounts at the same time
129131
- change Accelerator configuration settings
130132

docs/installation/index.md

Lines changed: 28 additions & 21 deletions
Large diffs are not rendered by default.

reference-artifacts/Import-Account/cfn-awscloudformationstacksetexecutionrole.template.yml renamed to reference-artifacts/Custom-Scripts/Import-Account-CFN-Role-Template.yml

File renamed without changes.

reference-artifacts/upgradev117-cleanup/resolver-rule-cleanup.sh renamed to reference-artifacts/Custom-Scripts/resolver-rule-cleanup.sh

File renamed without changes.

reference-artifacts/SCPs/PBMMAccel-Guardrails-PBMM-Only.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@
8282
"Effect": "Deny",
8383
"NotAction": [
8484
"a4b:*",
85-
"access-analyzer:*",
8685
"acm:*",
8786
"aws-marketplace-management:*",
8887
"aws-marketplace:*",

reference-artifacts/SCPs/PBMMAccel-Guardrails-Unclass-Only.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
"Effect": "Deny",
2828
"NotAction": [
2929
"a4b:*",
30-
"access-analyzer:*",
3130
"aws-marketplace-management:*",
3231
"aws-marketplace:*",
3332
"aws-portal:*",

reference-artifacts/config-pbmm-standalone-full.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"central-log-retention": 730,
77
"default-log-retention": 90,
88
"central-bucket": "AWSDOC-EXAMPLE-BUCKET",
9-
"organization-admin-role": "OrganizationAccountAccessRole",
9+
"organization-admin-role": "AWSCloudFormationStackSetExecutionRole",
1010
"default-cwl-retention": 731,
1111
"workloadaccounts-suffix" : 1,
1212
"workloadaccounts-prefix" : "config",
@@ -64,6 +64,7 @@
6464
"ssm-to-s3": true,
6565
"ssm-to-cwl": true
6666
},
67+
"additional-cwl-regions": {},
6768
"reports": {
6869
"cost-and-usage-report": {
6970
"additional-schema-elements": ["RESOURCES"],

reference-artifacts/config-pbmm-standalone-lite.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"central-log-retention": 730,
77
"default-log-retention": 90,
88
"central-bucket": "AWSDOC-EXAMPLE-BUCKET",
9-
"organization-admin-role": "OrganizationAccountAccessRole",
9+
"organization-admin-role": "AWSCloudFormationStackSetExecutionRole",
1010
"default-cwl-retention": 731,
1111
"workloadaccounts-suffix" : 1,
1212
"workloadaccounts-prefix" : "config",
@@ -64,6 +64,7 @@
6464
"ssm-to-s3": true,
6565
"ssm-to-cwl": true
6666
},
67+
"additional-cwl-regions": {},
6768
"reports": {
6869
"cost-and-usage-report": {
6970
"additional-schema-elements": ["RESOURCES"],

reference-artifacts/config.example.json

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,6 @@
7878
"report-versioning": "OVERWRITE_REPORT"
7979
}
8080
},
81-
"conformance-packs": [
82-
{
83-
"gc-pack": {
84-
"install": true,
85-
"auto-remediation": true,
86-
"monitoring": true,
87-
"frequency": 24
88-
}
89-
}
90-
],
9181
"zones": {
9282
"account": "shared-network",
9383
"resolver-vpc": "Endpoint",
@@ -487,7 +477,7 @@
487477
"central-resolver-rule-account": "shared-network",
488478
"central-resolver-rule-vpc": "Endpoint",
489479
"log-group-name": "/PBMMAccel/MAD/example.local",
490-
"share-to-account": "master",
480+
"share-to-account": "",
491481
"restrict_srcips": ["10.0.0.0/8", "100.96.252.0/23", "100.96.250.0/23"],
492482
"num-rdgw-hosts": 1,
493483
"min-rdgw-hosts": 1,
@@ -1146,7 +1136,7 @@
11461136
"email": "myemail+pbmmT-master@example.com---------------------REPLACE----------------------",
11471137
"ou": "core",
11481138
"landing-zone-account-type": "primary",
1149-
"share-mad-from": "operations",
1139+
"share-mad-from": "",
11501140
"src-filename": "config.json",
11511141
"budget": {
11521142
"name": "Organization Budget",
@@ -3260,14 +3250,6 @@
32603250
}
32613251
]
32623252
},
3263-
"certificates": [
3264-
{
3265-
"name": "UnclassSelf-SignedCert",
3266-
"type": "import",
3267-
"priv-key": "certs/example1-cert.key",
3268-
"cert": "certs/example1-cert.crt"
3269-
}
3270-
],
32713253
"vpc": [
32723254
{
32733255
"deploy": "shared-network",

0 commit comments

Comments
 (0)