Skip to content

Commit a4501c6

Browse files
Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.38.6) from the [email protected] source branch. (#2435)
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent 2a0e4f3 commit a4501c6

File tree

9 files changed

+126
-101
lines changed

9 files changed

+126
-101
lines changed

docs/reference/modules/terraform-aws-ecs/ecs-cluster/ecs-cluster.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Amazon ECS" version="0.38.5" lastModifiedVersion="0.38.4"/>
12+
<VersionBadge repoTitle="Amazon ECS" version="0.38.6" lastModifiedVersion="0.38.6"/>
1313

1414
# ECS Cluster Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.38.4" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.38.6" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This Terraform Module launches an [EC2 Container Service
2121
Cluster](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html) that you can use to run
22-
Docker containers and services (see the [ecs-service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-service/README.adoc)).
22+
Docker containers and services (see the [ecs-service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-service/README.adoc)).
2323

2424
**WARNING: Launch Configurations:** [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) are being phased out in favor of [Launch Templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html). Before upgrading to the latest release please be sure to test and plan any changes to infrastructure that may be impacted. Launch templates are being introduced in [PR #371](https://github.com/gruntwork-io/terraform-aws-ecs/pull/371)
2525

@@ -32,7 +32,7 @@ ECS and register itself as part of the right cluster.
3232

3333
## How do you run Docker containers on the cluster?
3434

35-
See the [service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-service/README.adoc).
35+
See the [service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-service/README.adoc).
3636

3737
## How do you add additional security group rules?
3838

@@ -97,7 +97,7 @@ currently no way in ECS to manage IAM policies on a per-Docker-container basis.
9797

9898
## How do you make changes to the EC2 Instances in the cluster?
9999

100-
To deploy an update to an ECS Service, see the [ecs-service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-service). To deploy an update to the
100+
To deploy an update to an ECS Service, see the [ecs-service module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-service). To deploy an update to the
101101
EC2 Instances in your ECS cluster, such as a new AMI, read on.
102102

103103
Terraform and AWS do not provide a way to automatically roll out a change to the Instances in an ECS Cluster. Due to
@@ -127,8 +127,8 @@ To deploy a change such as rolling out a new AMI to all ECS Instances:
127127
python3 roll-out-ecs-cluster-update.py --asg-name ASG_NAME --cluster-name CLUSTER_NAME --aws-region AWS_REGION
128128
```
129129
130-
If you have your output variables configured as shown in [outputs.tf](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/examples/docker-service-with-elb/outputs.tf)
131-
of the [docker-service-with-elb example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/examples/docker-service-with-elb), you can use the `terraform output`
130+
If you have your output variables configured as shown in [outputs.tf](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/examples/docker-service-with-elb/outputs.tf)
131+
of the [docker-service-with-elb example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/examples/docker-service-with-elb), you can use the `terraform output`
132132
command to fill in most of the arguments automatically:
133133
134134
```
@@ -181,8 +181,8 @@ To deploy a change such as rolling out a new AMI to all ECS Instances:
181181
python3 asg-instance-refresh.py --asg-name ASG_NAME --aws-region AWS_REGION
182182
```
183183
184-
If you have your output variables configured as shown in [outputs.tf](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/examples/docker-service-with-elb/outputs.tf)
185-
of the [docker-service-with-elb example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/examples/docker-service-with-elb), you can use the `terraform output`
184+
If you have your output variables configured as shown in [outputs.tf](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/examples/docker-service-with-elb/outputs.tf)
185+
of the [docker-service-with-elb example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/examples/docker-service-with-elb), you can use the `terraform output`
186186
command to fill in most of the arguments automatically:
187187
188188
```
@@ -235,7 +235,7 @@ enable Capacity Providers on an existing ECS cluster that did not have Capacity
235235
instances to ensure all the instances get associated with the new Capacity Provider.
236236

237237
To rotate the instances, you can run the
238-
[roll-out-ecs-cluster-update.py](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster/roll-out-ecs-cluster-update.py)
238+
[roll-out-ecs-cluster-update.py](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster/roll-out-ecs-cluster-update.py)
239239
script in the `terraform-aws-ecs` module. Refer to the
240240
[documentation](#how-do-you-make-changes-to-the-ec2-instances-in-the-cluster)
241241
for more information on the script.
@@ -253,7 +253,7 @@ for more information on the script.
253253
254254
module "ecs_cluster" {
255255
256-
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-cluster?ref=v0.38.5"
256+
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-cluster?ref=v0.38.6"
257257
258258
# ----------------------------------------------------------------------------------------------------
259259
# REQUIRED VARIABLES
@@ -336,6 +336,14 @@ module "ecs_cluster" {
336336
# GroupTotalCapacity, GroupTotalInstances.
337337
cluster_asg_metrics_enabled = []
338338
339+
# Amount of time, in seconds, until a newly launched instance can contribute
340+
# to the Amazon CloudWatch metrics. This delay lets an instance finish
341+
# initializing before Amazon EC2 Auto Scaling aggregates instance metrics,
342+
# resulting in more reliable usage data. Set this value equal to the amount of
343+
# time that it takes for resource consumption to become stable after an
344+
# instance reaches the InService state.
345+
cluster_default_instance_warmup = null
346+
339347
# Enables/disables detailed CloudWatch monitoring for EC2 instances
340348
cluster_detailed_monitoring = true
341349
@@ -534,7 +542,7 @@ module "ecs_cluster" {
534542
# ------------------------------------------------------------------------------------------------------
535543
536544
terraform {
537-
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-cluster?ref=v0.38.5"
545+
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-cluster?ref=v0.38.6"
538546
}
539547
540548
inputs = {
@@ -620,6 +628,14 @@ inputs = {
620628
# GroupTotalCapacity, GroupTotalInstances.
621629
cluster_asg_metrics_enabled = []
622630
631+
# Amount of time, in seconds, until a newly launched instance can contribute
632+
# to the Amazon CloudWatch metrics. This delay lets an instance finish
633+
# initializing before Amazon EC2 Auto Scaling aggregates instance metrics,
634+
# resulting in more reliable usage data. Set this value equal to the amount of
635+
# time that it takes for resource consumption to become stable after an
636+
# instance reaches the InService state.
637+
cluster_default_instance_warmup = null
638+
623639
# Enables/disables detailed CloudWatch monitoring for EC2 instances
624640
cluster_detailed_monitoring = true
625641
@@ -977,6 +993,15 @@ A list of metrics to collect. The allowed values are GroupDesiredCapacity, Group
977993
<HclListItemDefaultValue defaultValue="[]"/>
978994
</HclListItem>
979995

996+
<HclListItem name="cluster_default_instance_warmup" requirement="optional" type="number">
997+
<HclListItemDescription>
998+
999+
Amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state.
1000+
1001+
</HclListItemDescription>
1002+
<HclListItemDefaultValue defaultValue="null"/>
1003+
</HclListItem>
1004+
9801005
<HclListItem name="cluster_detailed_monitoring" requirement="optional" type="bool">
9811006
<HclListItemDescription>
9821007

@@ -1455,11 +1480,11 @@ Set this variable to true to enable the use of Instance Metadata Service Version
14551480
<!-- ##DOCS-SOURCER-START
14561481
{
14571482
"originalSources": [
1458-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster/readme.md",
1459-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster/variables.tf",
1460-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster/outputs.tf"
1483+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster/readme.md",
1484+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster/variables.tf",
1485+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster/outputs.tf"
14611486
],
14621487
"sourcePlugin": "module-catalog-api",
1463-
"hash": "356294e32c5364373b250bf884f708d3"
1488+
"hash": "0cf6c03b8e60bdefb6fc6908b26379ee"
14641489
}
14651490
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-ecs/ecs-daemon-service/ecs-daemon-service.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Amazon ECS" version="0.38.5" lastModifiedVersion="0.38.1"/>
12+
<VersionBadge repoTitle="Amazon ECS" version="0.38.6" lastModifiedVersion="0.38.1"/>
1313

1414
# ECS Daemon Service Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-daemon-service" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-daemon-service" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.38.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -33,7 +33,7 @@ environment variables to set, and so on. To actually run an ECS Task, you define
3333

3434
## How do you create an ECS cluster?
3535

36-
To use ECS, you first deploy one or more EC2 Instances into a "cluster". See the [ecs-cluster module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-cluster)
36+
To use ECS, you first deploy one or more EC2 Instances into a "cluster". See the [ecs-cluster module](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-cluster)
3737
for how to create a cluster.
3838

3939
## How do you add additional IAM policies?
@@ -82,7 +82,7 @@ EOF
8282
8383
module "ecs_daemon_service" {
8484
85-
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-daemon-service?ref=v0.38.5"
85+
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-daemon-service?ref=v0.38.6"
8686
8787
# ----------------------------------------------------------------------------------------------------
8888
# REQUIRED VARIABLES
@@ -198,7 +198,7 @@ module "ecs_daemon_service" {
198198
# ------------------------------------------------------------------------------------------------------
199199
200200
terraform {
201-
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-daemon-service?ref=v0.38.5"
201+
source = "git::[email protected]:gruntwork-io/terraform-aws-ecs.git//modules/ecs-daemon-service?ref=v0.38.6"
202202
}
203203
204204
inputs = {
@@ -566,11 +566,11 @@ If true, Terraform will wait for the service to reach a steady state—as in, th
566566
<!-- ##DOCS-SOURCER-START
567567
{
568568
"originalSources": [
569-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-daemon-service/readme.md",
570-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-daemon-service/variables.tf",
571-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-daemon-service/outputs.tf"
569+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-daemon-service/readme.md",
570+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-daemon-service/variables.tf",
571+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-daemon-service/outputs.tf"
572572
],
573573
"sourcePlugin": "module-catalog-api",
574-
"hash": "b811bd841e1ce6327c55517e4383e92c"
574+
"hash": "e820e732fdcc21a5215ba6169b7e6687"
575575
}
576576
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-ecs/ecs-deploy/ecs-deploy.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Amazon ECS" version="0.38.5" lastModifiedVersion="0.37.0"/>
12+
<VersionBadge repoTitle="Amazon ECS" version="0.38.6" lastModifiedVersion="0.37.0"/>
1313

1414
# ECS Deployment Scripts
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-deploy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-deploy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.37.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -48,7 +48,7 @@ The `run-ecs-task` script assumes you already have the following:
4848
resource](https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html). You'll need to know the family
4949
name and revision of the ECS Task Definition you want to run.
5050

51-
Check out the [deploy-ecs-task example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/examples/deploy-ecs-task) for working sample code of both of the above.
51+
Check out the [deploy-ecs-task example](https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/examples/deploy-ecs-task) for working sample code of both of the above.
5252

5353
To run the ECS Task Definition `db-backup` at revision `3` in an ECS Cluster named `ecs-stage` in `us-west-2`, use the
5454
following command:
@@ -95,11 +95,11 @@ container instead of the command configured in the Task Definition.
9595
<!-- ##DOCS-SOURCER-START
9696
{
9797
"originalSources": [
98-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-deploy/readme.md",
99-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-deploy/variables.tf",
100-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-deploy/outputs.tf"
98+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-deploy/readme.md",
99+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-deploy/variables.tf",
100+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-deploy/outputs.tf"
101101
],
102102
"sourcePlugin": "module-catalog-api",
103-
"hash": "3726008c8d1a4833253c9721304850af"
103+
"hash": "d2997477dc45120b3e5bb18beedc50b8"
104104
}
105105
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-ecs/ecs-fargate/ecs-fargate.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Amazon ECS" version="0.38.5" lastModifiedVersion="0.24.1"/>
12+
<VersionBadge repoTitle="Amazon ECS" version="0.38.6" lastModifiedVersion="0.24.1"/>
1313

1414
# Fargate Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-fargate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-fargate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-ecs/releases/tag/v0.24.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -23,11 +23,11 @@ guide in [the release notes](https://github.com/gruntwork-io/terraform-aws-ecs/r
2323
<!-- ##DOCS-SOURCER-START
2424
{
2525
"originalSources": [
26-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-fargate/readme.md",
27-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-fargate/variables.tf",
28-
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.5/modules/ecs-fargate/outputs.tf"
26+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-fargate/readme.md",
27+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-fargate/variables.tf",
28+
"https://github.com/gruntwork-io/terraform-aws-ecs/tree/v0.38.6/modules/ecs-fargate/outputs.tf"
2929
],
3030
"sourcePlugin": "module-catalog-api",
31-
"hash": "b70755b1327717810ca2f223886c2ae4"
31+
"hash": "63710c30d8aba693078eaf67a3ce4279"
3232
}
3333
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)