From 9864d02d82ff23bdff4df48f8e36ce5937eb156e Mon Sep 17 00:00:00 2001 From: Matthew Zhao Date: Wed, 3 Mar 2021 18:32:43 -0800 Subject: [PATCH] a bit better readme --- deploy/aws/README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/deploy/aws/README.md b/deploy/aws/README.md index 773b23f..ef6ff2c 100644 --- a/deploy/aws/README.md +++ b/deploy/aws/README.md @@ -1,18 +1,15 @@ -# Welcome to your CDK TypeScript project! - -This is a blank project for TypeScript development with CDK. - -The `cdk.json` file tells the CDK Toolkit how to execute your app. - -## Useful commands - - * `npm run build` compile typescript to js - * `npm run watch` watch for changes and compile - * `npm run test` perform the jest unit tests - * `cdk deploy` deploy this stack to your default AWS account/region - * `cdk diff` compare deployed stack with current state - * `cdk synth` emits the synthesized CloudFormation template +# This is the deployment Infrastructure as code for use with AWS ## configuration, please set them as env var * `LOCALTUNNEL_BASE_DOMAIN` the base domain for the localtunnel server, must be a root domain like example.com * `LOCALTUNNEL_ROUTE53_ID` the ID of the route53 hosted zone for the domain + +## After setting the environment variables, simply run: + ```npm i && cdk deploy``` + +## Deployed Architecture +1. This Architecture brings up a ECS fargate cluster, 2 public subnets, 2 private subnets, and 2 NAT gateways + +2. It spins up a container that runs using fargate runtype with the upstream docker image + +3. the container image is placed in one of the two private subnets \ No newline at end of file