https://github.com/richardfan1126/ssm-patch-portal
A webportal that can help you easily manage instance patching via AWS SSM Patch Manager
https://github.com/richardfan1126/ssm-patch-portal
aws aws-ssm patch-management
Last synced: about 1 year ago
JSON representation
A webportal that can help you easily manage instance patching via AWS SSM Patch Manager
- Host: GitHub
- URL: https://github.com/richardfan1126/ssm-patch-portal
- Owner: richardfan1126
- License: apache-2.0
- Created: 2022-02-28T06:26:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-28T09:58:07.000Z (about 4 years ago)
- Last Synced: 2025-04-15T03:55:27.286Z (about 1 year ago)
- Topics: aws, aws-ssm, patch-management
- Language: Python
- Homepage:
- Size: 4.8 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SSM Patch Portal
## Demo
## Deployment guide
### Prerequisite
#### Local build
* [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install)
* [npm](https://nodejs.org/en/download/)
* [npx](https://www.npmjs.com/package/npx)
* [Python3 and pip3](https://www.python.org/downloads/)
* [jq](https://stedolan.github.io/jq/download/) (Optional)
#### Docker build
* [Docker](https://docs.docker.com/get-docker/)
### Steps
1. Clone the repository
```bash
git clone https://github.com/richardfan1126/ssm-patch-portal.git --recurse-submodules
```
1. Create a `.env` file inside project root
Input the value for the following parameters
1. **Ec2IamRoleArns**
All the IAM Role ARNs that is attached to the targeted EC2 instances. This is for granting access to those EC2 instances over the S3 bucket containing install patch lists and command output.
```
export Ec2IamRoleArns=,,...,
```
1. **AdminEmail**
The email address where the initial admin password will be sent to. Make sure this email address can receive incoming mail.
```
export AdminEmail=
```
1. (Optional) Install and bootstrap required tools
For AWS CDK, make sure you have already run the [bootstrap](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_bootstrap) command
```bash
cdk bootstrap aws://ACCOUNT-NUMBER/REGION
```
1. Run the deploy script
(For local build)
```bash
./deploy.sh
```
---
(For Docker build)
Run `./docker-build/deploy.sh`.
```bash
./docker-build/deploy.sh
```
When prompted, specify the location of aws credential.
More detail on: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-where. (Default: ~/.aws)
```bash
Please specify the location of AWS credential [~/.aws]
```
1. After the backend deployment, press Y + \ to continue the frontend deployment.
```
Continue to deploy frontend stack? (Y/n) Y
```
1. When the deployment completes, you can go to the web portal via the URL provided.
Use the password, which was sent to your email, to login.
```
Outputs:
SsmPatchPortalFrontend.PortalURL = https://xxxxxxxxxxxxxx.cloudfront.net
...
```
## Cleanup
1. Delete CloudFormation Stacks
1. **SsmPatchPortal**
1. **SsmPatchPortalFrontend**
1. Empty and delete S3 buckets. (The bucket name have the following prefix)
1. **ssmpatchportalfrontend-**
1. **ssmpatchportal-s3bucketsta-**
1. Delete SSM associations
1. **ssm-patch-portal-****
1. **ssm-patch-portal-scan**
## Architecture
