From 49b71b0ba32fb18777f63f94dfbcd4776e2bd642 Mon Sep 17 00:00:00 2001 From: Yohta Kimura <38206553+rajyan@users.noreply.github.com> Date: Sun, 11 Sep 2022 17:34:14 +0900 Subject: [PATCH] chore: readme small fixes (#35) Fixes # --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 83249ff..d1346ca 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ A CDK construct that provides easy and [low-cost](#cost) ECS on EC2 server setup without a load balancer. -**This construct is for development purposes only** see [Limitations](#limitations). +**This construct is for development purposes only**. See [Limitations](#limitations). # Try it out! -The easiest way to see what this construct creates is to clone this repository and deploying a sample server. -Edit settings in `bin/low-cost-ecs.ts` and deploy cdk construct. [Public hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html) is required. +The easiest way to see what this construct creates is to clone this repository and deploy the sample server. +Edit settings in `bin/low-cost-ecs.ts` and deploy the cdk construct. [Public hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html) is required. ``` git clone https://github.com/rajyan/low-cost-ecs.git @@ -55,16 +55,16 @@ class SampleStack extends Stack { ``` The required fields are `hostedZoneDomain` and `email`. -You can configure your server task definition, and other props. Read [`LowCostECSProps` documentation](https://github.com/rajyan/low-cost-ecs/blob/main/API.md#low-cost-ecs.LowCostECSProps) for details. +You can configure your server task definition and other props. Read [`LowCostECSProps` documentation](https://github.com/rajyan/low-cost-ecs/blob/main/API.md#low-cost-ecs.LowCostECSProps) for details. # Why ECS may often seem expensive when used for personal development purposes, because of the cost of the load balancer. -The application load balancer is a great service because it is easy to set up managed ACM certificates, it scales, and has dynamic port mapping, +The application load balancer is a great service because it is easy to set up managed ACM certificates, it scales, and has dynamic port mappings and so on, but it is over-featured for running 1 ECS service. -However, to run an ECS sever without a load balancer, you need to associate an Elastic IP to the host instance and install your certificate by yourself. -This construct aims to automate these works and deploy resources to run a low-cost ECS server. +However, to run an ECS server without a load balancer, you need to associate an Elastic IP to the host instance and install your certificate by yourself. +This construct aims to automate these works and to make it easy to deploy resources to run a low-cost ECS server. # Overview @@ -77,7 +77,7 @@ Resources generated in this stack * Scheduled automated renewal every 60 days * Email notification on certbot task failure * ECS on EC2 host instance - * ECS-optimized Amazon Linux 2 AMI instance auto scaling group + * ECS-optimized Amazon Linux 2 AMI instance auto-scaling group * Automatically associated with Elastic IP on instance initialization * ECS Service * TLS/SSL certificate installation on default container startup @@ -132,4 +132,5 @@ aws ecs execute-command \ The ECS service occupies the host port, only one service can be run at a time. The old task must be terminated before the new task launches, and this causes downtime on release. + Also, if you make changes that require recreating service, you may need to manually terminate the task of old the service.