Skip to content

Commit 050854c

Browse files
authored
Easy setup (#140)
* easy setup * fix s3 bpa dead link * fix rAWSControlTowerRole Arn output * easy setup * fix dead s3 link * update readme links * update readme links
1 parent 8fd18d9 commit 050854c

File tree

11 files changed

+2462
-12
lines changed

11 files changed

+2462
-12
lines changed

CHANGELOG.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Table of Contents<!-- omit in toc -->
44

55
- [Introduction](#introduction)
6+
- [2023-05-05](#2023-05-05)
67
- [2023-04-10](#2023-04-10)
78
- [2023-01-19](#2023-01-19)
89
- [2022-12-02](#2022-12-02)
@@ -34,12 +35,16 @@
3435
All notable changes to this project will be documented in this file.
3536

3637
---
38+
## 2023-05-05
39+
40+
### Changed<!-- omit in toc -->
41+
42+
- Added the [Easy Setup](aws_sra_examples/easy_setup) solution to enhance customer experience during deployment operations.
3743
## 2023-04-10
3844

3945
### Changed<!-- omit in toc -->
4046

4147
- Added NIST Security Standard to Security Hub solution [Security Hub Organization](aws_sra_examples/solutions/securityhub/securityhub_org)
42-
---
4348

4449
## 2023-01-19
4550

@@ -95,7 +100,7 @@ All notable changes to this project will be documented in this file.
95100
- [EC2 Default EBS Encryption](aws_sra_examples/solutions/ec2/ec2_default_ebs_encryption) solution updates:
96101
- Added DeadLetterConfig to the Lambda function.
97102
- Removed the checkov suppression for not having a DLQ configured.
98-
- [S3 Block Account Public Access](aws_sra_examples/solutions/s3_block_account_public_access) solution updates:
103+
- [S3 Block Account Public Access](aws_sra_examples/solutions/s3/s3_block_account_public_access) solution updates:
99104
- Removed the checkov suppression for not having a DLQ configured.
100105

101106
## 2022-05-15
@@ -112,7 +117,7 @@ All notable changes to this project will be documented in this file.
112117
- Added account and organization event support.
113118
- Added SNS fanout for configuring accounts to replace multi-threading.
114119
- Added Lambda environment variables to replace SSM parameter for configuration.
115-
- [S3 Block Account Public Access](aws_sra_examples/solutions/s3_block_account_public_access) solution updates:
120+
- [S3 Block Account Public Access](aws_sra_examples/solutions/s3/s3_block_account_public_access) solution updates:
116121
- Added account and organization event support.
117122
- Added SNS fanout for configuring accounts to replace multi-threading.
118123
- Added Lambda environment variables to replace SSM parameter for configuration.

README.md

+34-8
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-
77
## Table of Contents<!-- omit in toc -->
88

99
- [Introduction](#introduction)
10-
- [Getting Started with the SRA Code Examples](#getting-started-with-the-sra-code-examples)
11-
- [Quick Setup](#quick-setup)
10+
- [Getting Started Using the AWS SRA Easy Setup (Recommended)](#getting-started-using-the-aws-sra-easy-setup-recommended)
11+
- [AWS SRA Easy Setup](#aws-sra-easy-setup)
12+
- [Manual Install Method For the AWS SRA](#manual-install-method-for-the-aws-sra)
13+
- [AWS SRA Quick Setup](#aws-sra-quick-setup)
1214
- [Example Solutions](#example-solutions)
1315
- [Utils](#utils)
1416
- [Environment Setup](#environment-setup)
@@ -28,24 +30,48 @@ to modify and tailor these solutions to suit your environment and security needs
2830

2931
The examples within this repository have been deployed and tested within an `AWS Control Tower` environment using `AWS CloudFormation` as well as the `Customizations for AWS Control Tower (CFCT)` solution.
3032

31-
## Getting Started with the SRA Code Examples
33+
## Getting Started Using the AWS SRA Easy Setup (Recommended)
3234

33-
![How to get started process diagram](./aws_sra_examples/docs/artifacts/where-to-start-process.png)
35+
![How to get started with the easy setup process diagram](./aws_sra_examples/docs/artifacts/easy-setup-process.png)
36+
37+
1. Setup the environment to configure [AWS Control Tower](https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html) within a new or existing AWS account. Existing AWS Control Tower environments can also be used but may require existing service configurations to be removed.
38+
2. Choose a deployment method:
39+
- AWS CloudFormation StackSets/Stacks - [CFN AWS SRA Easy Setup Implementation Details](./aws_sra_examples/easy_setup#cloudformation-implementation-instructions)
40+
- See [AWS CloudFormation Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) for more information.
41+
- Customizations for AWS Control Tower (CfCT) - [CfCT AWS SRA Easy Setup Implementation Details](./aws_sra_examples/easy_setup#customizations-for-control-tower-implementation-instructions)
42+
- See [CfCT Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/) for more information.
43+
3. If using CfCT, deploy the AWSControlTowerExecution role into the management account.
44+
4. Using parameters within the easy setup template file, choose which AWS SRA Solutions to deploy. This can be done during initial setup or as an update later.
45+
46+
For more information view the [AWS SRA Easy Setup](./aws_sra_examples/easy_setup) solution page.
47+
48+
### AWS SRA Easy Setup
49+
50+
Using the AWS SRA Easy Setup, the common prerequisites and all AWS SRA solutions are automatically packaged, staged, and deployed into your AWS environment with minimal effort. This is the recommended method to install the AWS SRA code library because it reduces the likelihood of missing a step in the Manual install method. If using this method to install the AWS SRA code library, there is no other process you need to follow.
51+
52+
Follow the instructions in the [AWS SRA Easy Setup](./aws_sra_examples/easy_setup) solution page to install everything you need to get the AWS SRA code library and it's solutions deployed.
53+
54+
## Manual Install Method For the AWS SRA
55+
56+
![How to get started process diagram (manual install)](./aws_sra_examples/docs/artifacts/where-to-start-process.png)
3457

3558
1. Setup the environment to configure [AWS Control Tower](https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html) within a new or existing AWS account. Existing AWS Control Tower environments can also be used but may require existing service configurations to be removed.
3659
2. Deploy the [Common Prerequisites](aws_sra_examples/solutions/common/common_prerequisites) solution. **Note:** This only needs to be done once for all the solutions.
3760
3. Choose a deployment method:
3861
- AWS CloudFormation StackSets/Stacks - [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html)
39-
- Customizations for AWS Control Tower (CFCT) - [Solution Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/)
62+
- Customizations for AWS Control Tower (CfCT) - [Solution Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/)
4063
4. (Optional) - Deploy the [Customizations for AWS Control Tower (CFCT) Setup](aws_sra_examples/solutions/common/common_cfct_setup) solution. **Note** Only implement if the CFCT deployment method was selected.
41-
5. Per your requirements select one or all of the below [Example Solutions](#example-solutions) to implement via the selected deployment method.
64+
5. Per your requirements select one or all of the below [AWS SRA Solutions](#example-solutions) to implement via the selected deployment method.
65+
- You may use the `Quick Setup` to deploy the AWS SRA Solutions at this step.
4266

43-
## Quick Setup
67+
### AWS SRA Quick Setup
4468

45-
With the `Quick Setup` you can now deploy all the [Example Solutions](#example-solutions) listed in the below table via a single centralized CloudFormation template either directly within the CloudFormation console or via the Customizations for AWS Control Tower (CFCT) solution. Our testing within an environment that has the default AWS Control Tower setup (3 accounts and 1 region) resulted in deploying all the solutions within the `Quick Setup` in under 20 minutes.
69+
The `Quick Setup` can be used along with the manual install of the AWS SRA. Once you have manually installed the common prerequisites, instead of installing each solution individually, you can deploy all the [Example Solutions](#example-solutions) listed in the below table via a single centralized CloudFormation template either directly within the CloudFormation console or via the Customizations for AWS Control Tower (CFCT) solution. Our testing within an environment that has the default AWS Control Tower setup (3 accounts and 1 region) resulted in deploying all the solutions within the `Quick Setup` in under 20 minutes.
4670

4771
Follow the instructions within the [Quick Setup](aws_sra_examples/quick_setup) to deploy all or a subset of the solutions based on your environment requirements.
4872

73+
*Note: The `Quick Setup` is not designed to be used with the `Easy Setup` procedure. Using them together may produce mixed results as we have not tested this. It is recommended to use the `Easy Setup` process*
74+
4975
## Example Solutions
5076

5177
- **Note:** All solutions below depend on the [Common Prerequisites](aws_sra_examples/solutions/common/common_prerequisites) solution in addition to the specified solutions within the `Depends On` column.
Loading
Binary file not shown.

0 commit comments

Comments
 (0)