Skip to content

Commit 712911d

Browse files
committed
refactor(examples/complete): update README
1 parent ca385dc commit 712911d

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

examples/complete/.header.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ECS Deployment Complete
2+
3+
Configuration in this directory creates:
4+
5+
- VPC with two private subnets and two public subnets
6+
- Autoscaling Group with a Launch Template
7+
- ECS Service in a pre-configured ECS Cluster to spin up a Nginx web server, and corresponding ECS Capacity Providers
8+
- Internet-facing Application Load Balancer to access the internal Nginx server, and
9+
- ACM to generate an Amazon-issued certificate for a base domain, and then create a Route53 A-type record with an endpoint
10+
11+
## Usage
12+
13+
To run this example, you will need to execute the commands:
14+
15+
```bash
16+
terraform init
17+
terraform plan
18+
terraform apply
19+
```
20+
21+
Please note that this example may create resources that can incur monetary charges on your AWS bill. You can run `terraform destroy` when you no longer need the resources.

examples/complete/README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- BEGIN_TF_DOCS -->
12
# ECS Deployment Complete
23

34
Configuration in this directory creates:
@@ -20,7 +21,6 @@ terraform apply
2021

2122
Please note that this example may create resources that can incur monetary charges on your AWS bill. You can run `terraform destroy` when you no longer need the resources.
2223

23-
<!-- BEGIN_TF_DOCS -->
2424
## Requirements
2525

2626
| Name | Version |
@@ -37,10 +37,7 @@ Please note that this example may create resources that can incur monetary charg
3737

3838
| Name | Source | Version |
3939
|------|--------|---------|
40-
| <a name="module_acm"></a> [acm](#module\_acm) | ../../modules/acm | n/a |
41-
| <a name="module_alb"></a> [alb](#module\_alb) | ../../modules/alb | n/a |
42-
| <a name="module_asg"></a> [asg](#module\_asg) | ../../modules/asg | n/a |
43-
| <a name="module_capacity_provider"></a> [capacity\_provider](#module\_capacity\_provider) | ../../modules/capacity-provider | n/a |
40+
| <a name="module_asg"></a> [asg](#module\_asg) | terraform-aws-modules/autoscaling/aws | n/a |
4441
| <a name="module_ecs_deployment"></a> [ecs\_deployment](#module\_ecs\_deployment) | ../../ | n/a |
4542
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.9.0 |
4643

@@ -67,7 +64,6 @@ No inputs.
6764
| <a name="output_acm_amazon_issued_certificate_arn"></a> [acm\_amazon\_issued\_certificate\_arn](#output\_acm\_amazon\_issued\_certificate\_arn) | ARN of the ACM Amazon-issued certificate for the base domain |
6865
| <a name="output_alb_allow_all_sg_id"></a> [alb\_allow\_all\_sg\_id](#output\_alb\_allow\_all\_sg\_id) | ID of the Security Group for Application Load Balancer to allow all traffic from any source |
6966
| <a name="output_alb_arn"></a> [alb\_arn](#output\_alb\_arn) | ARN of the Application Load Balancer for Nginx ECS Service |
70-
| <a name="output_alb_id"></a> [alb\_id](#output\_alb\_id) | Identifier of the Application Load Balancer for Nginx ECS Service |
7167
| <a name="output_allow_all_within_vpc_sg_id"></a> [allow\_all\_within\_vpc\_sg\_id](#output\_allow\_all\_within\_vpc\_sg\_id) | ID of the Security Group to allow all traffic from any source within the VPC |
7268
| <a name="output_allow_nginx_http_from_alb_sg_id"></a> [allow\_nginx\_http\_from\_alb\_sg\_id](#output\_allow\_nginx\_http\_from\_alb\_sg\_id) | ID of the Security Group to allow all Nginx HTTP traffic from Application Load Balancer |
7369
| <a name="output_asg_arn"></a> [asg\_arn](#output\_asg\_arn) | ARN of the Autoscaling group |

0 commit comments

Comments
 (0)