Skip to content

Commit c74c4be

Browse files
committed
README
1 parent 39711c0 commit c74c4be

File tree

1 file changed

+20
-53
lines changed
  • aws_sra_examples/solutions/patch_mgmt/patch_mgmt_org

1 file changed

+20
-53
lines changed

aws_sra_examples/solutions/patch_mgmt/patch_mgmt_org/README.md

Lines changed: 20 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,11 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-
1414

1515
## Introduction
1616

17-
The Patch Manager solution will automate enabling Systems Manager - Patch manager by delegating administration to an account (e.g. Audit or Security Tooling) and configuring Patch Manager for all the existing and future AWS Organization accounts.
17+
The SRA Patch Manager solution will automate enabling Systems Manager - Patch manager by configuring Patch Manager for all the existing AWS Organization accounts.
1818

1919
**Key solution features:**
20-
21-
- Delegates Patch Manager administration to another account (i.e Audit account).
22-
TODO: If we were to do this, we would need to delegate for all of Systems Manager.
23-
24-
- Assumes a role in the delegated administrator account to configure organizations management.
25-
- Assumes a role in each member account to enable/disable standards aligning with the delegated administrator account.
20+
- Assumes a role in each member account to enable/disable the Patch Manager Solution.
21+
- Configures the [Default Host Configuration](https://docs.aws.amazon.com/systems-manager/latest/userguide/quick-setup-default-host-management-configuration.html) feature.
2622
- Ability to disable Patch Manager within all accounts and regions via a parameter and CloudFormation update event.
2723

2824
---
@@ -33,6 +29,7 @@ The Patch Manager solution requires:
3329
- SSM Agent 3.0.502 or later to be installed on the managed node
3430
- Internet connectivity from the managed node to the source patch repositories
3531
- Supported OS
32+
- A tag is applied to the Manage Instance. Key: InstanceOS Value: Linux or Windows
3633

3734
---
3835

@@ -50,40 +47,32 @@ The Patch Manager solution requires:
5047

5148
#### 1.2 IAM Roles<!-- omit in toc -->
5249

53-
- The `Lambda IAM Role` is used by the Lambda function to enable the Patch Manager Delegated Administrator Account within each region provided.
54-
- The `Configuration IAM Role` is assumed by the Lambda function to configure Patch Manager within the delegated administrator account and all member accounts.
55-
- The `SSMAutomation Role` is used by the Maintenance Window to execute the task.
50+
- The `Lambda IAM Role` is used by the Lambda function in the management account to enable the Patch Manager in the management account.
51+
- The `Patch Management IAM Role` is assumed by the Lambda function in each of the member accounts to to configure Patch Manager.
52+
- The `SSM Automation Role` is used by the Maintenance Window to execute the task.
5653
- The `DefaultHostConfig Role` is used to enable the Default Host Configuration setting.
57-
- The `AWSSystemsManagerDefaultEC2InstanceManagement Role` profile is automatically attached to new instances.
5854

5955
#### 1.3 Maintenance Windows<!-- omit in toc -->
6056

6157
##### Maintenance Windows Window
6258

63-
Three maintenance windows are created:
64-
- `Update_Linux` Linux Patch Scans
65-
- `Update_Windows` Windows Patch Scans
59+
One maintenance windows is created:
6660
- `Update_SSMAgent` updates SSM Agent
6761

6862
##### Maintenance Windows Tasks
6963

70-
Three tasks are created and registered with the windows:
71-
- `AWS-RunPatchBaseline` Runs a patch scan on Linux
72-
- `AWS-RunPatchBaseline` Runs a patch scan on Windows
64+
One task is created and registered with the window:
7365
- `AWS-UpdateSSMAgent` Runs an SSM Agent update on Linux and Windows
7466

7567
##### Maintenance Window Targets
7668

77-
Three targets are created and registered with the windows:
78-
- `Update_Linux` which includes all instances with the tag InstanceOS:Linux
79-
- `Update_Windows` which includes all instances with the tag InstanceOS:Windows
69+
One target is created and registered with the window:
8070
- `Update_SSMAgent` which includes all instances with the tag InstanceOS:Windows or InstanceOS:Linux
8171

8272
#### 1.4 Command Documents<!-- omit in toc -->
8373

8474
These AWS Managed SSM Documents are used by the tasks:
8575
- AWS-UpdateSSMAgent
86-
- AWS-RunPatchBaseline
8776

8877

8978
## Implementation Instructions
@@ -102,22 +91,16 @@ Choose a Deployment Method:
10291

10392
#### AWS CloudFormation<!-- omit in toc -->
10493

105-
In the `management account (home region)`, launch the [sra-inspector-org-main-ssm.yaml](templates/sra-inspector-org-main-ssm.yaml) template. This uses an approach where some of the CloudFormation parameters are populated from SSM parameters created by the [SRA Prerequisites Solution](../../common/common_prerequisites/).
94+
Refer to the [AWS SRA Easy Setup](https://github.com/aws-samples/aws-security-reference-architecture-examples/tree/main/aws_sra_examples/easy_setup#customizations-for-control-tower-implementation-instructions) Guide to pick the best installation type for you.
10695

107-
```bash
108-
aws cloudformation deploy --template-file $HOME/aws-sra-examples/aws_sra_examples/solutions/inspector/inspector_org/templates/sra-inspector-org-main-ssm.yaml --stack-name sra-inspector-org-main-ssm --capabilities CAPABILITY_NAMED_IAM
109-
```
96+
Choose to deploy the Patch Manager solution from within the chosen deployment type.
11097

11198
#### Verify Solution Deployment<!-- omit in toc -->
11299

113-
1. Log into the `management account` and navigate to the Inspector page
114-
1. Select Settings and then General
115-
1. Verify that the delegated admin account is set for each region
116-
2. Log into the Audit account and navigate to the Inspector page
117-
1. Verify the Inspector service is enabled in each region
118-
2. Verify the auto-enable ec2, ecr and lambda standard scanning for new accounts is ON in each region, and lambda code scanning in supported regions
119-
3. Verify all existing member accounts have inspector ec2, ecr, and lambda standard scanning enabled in each region, and lambda code scanning in supported regions
120-
3. Log into a member account and verify the inspector is enabled and configured to scan ec2, ecr, lambda functions and lambda code
100+
1. Log into the `management account` and navigate to the Systems Manager page.
101+
1. Select Maintenance Windows.
102+
2. Verify that there is now a maintnance window with registered tasks and targets.
103+
2. Log into a member account and verify the maintenance windows also exist.
121104

122105
#### Solution Update Instructions<!-- omit in toc -->
123106

@@ -126,28 +109,12 @@ In the `management account (home region)`, launch the [sra-inspector-org-main-ss
126109

127110
#### Solution Delete Instructions<!-- omit in toc -->
128111

129-
1. In the `management account (home region)`, delete the AWS CloudFormation **Stack** (`sra-inspector-org-main-ssm` or `sra-inspector-org-main`).
130-
2. In the `management account (home region)`, delete stack instances from the the AWS CloudFormation **StackSet** (`sra-inspector-org-main-ssm` or `sra-inspector-org-main`).
131-
3. In the `management account (home region)`, delete AWS CloudFormation **StackSet** (`sra-inspector-org-main-ssm` or `sra-inspector-org-main`).
132-
4. In the `management account (home region)`, verify that the Lambda function processing is complete by confirming no more CloudWatch logs are generated.
133-
5. In the `management account (home region)`, delete the AWS CloudWatch **Log Group** (e.g. /aws/lambda/<solution_name>) for the Lambda function deployed.
134-
135-
#### Instructions to Manually Run the Lambda Function<!-- omit in toc -->
136-
137-
1. In the `management account (home region)`.
138-
2. Navigate to the AWS Lambda Functions page.
139-
3. Select the `checkbox` next to the Lambda Function and select `Test` from the `Actions` menu.
140-
4. Scroll down to view the `Test event`.
141-
5. Click the `Test` button to trigger the Lambda Function with the default values.
142-
6. Verify that the updates were successful within the expected account(s).
112+
1. In the `management account (home region)`, delete the AWS CloudFormation **Stack** (`sra-patch-mgmt-main-ssm`).
143113

144114
---
145115

146116
## References
147117

148-
- [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)
149-
- [Managing AWS SDKs in Lambda Functions](https://docs.aws.amazon.com/lambda/latest/operatorguide/sdks-functions.html)
150-
- [Lambda runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)
151-
- [Python Boto3 SDK changelog](https://github.com/boto/boto3/blob/develop/CHANGELOG.rst)
152-
- [AWS Regions where Lambda code scanning is currently available](https://docs.aws.amazon.com/inspector/latest/user/inspector_regions.html)
153-
118+
- [AWS Systems Manager Patch Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager.html)
119+
- [Amazon Machine Images (AMIs) with SSM Agent preinstalled](https://docs.aws.amazon.com/systems-manager/latest/userguide/ami-preinstalled-agent.html)
120+
- [Troubleshooting managed node availability using ssm-cli](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-cli.html)

0 commit comments

Comments
 (0)