Skip to content

Commit a8a123f

Browse files
committed
chore: Correct wrappers and docs
1 parent 6f16fac commit a8a123f

File tree

5 files changed

+13
-14
lines changed

5 files changed

+13
-14
lines changed

docs/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,7 @@ This module supports creating a task execution IAM role in two different ways to
7373
The service sub-module creates one service that can be deployed onto a cluster. The service sub-module allows users to:
7474

7575
- Create an Amazon ECS service that ignores `desired_count`. This is intended for use when deploying task definition and container definition changes via Terraform
76-
- Create an Amazon ECS service that ignores `desired_count` and `task_definition`. This is intended to support a continuous deployment process that is responsible for updating the `image` and therefore the `task_definition` and `container_definition` while avoiding conflicts with Terraform.
77-
- Create an Amazon ECS service that ignores `desired_count`, `task_definition` and `load_balancer`. This is intended to support a continuous deployment process using [Blue/Green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/userguide/deployment-type-bluegreen.html) which will allow updating the `target_group_arn` while avoiding conflicts with Terraform.
76+
- Create an Amazon ECS service that ignores `desired_count` and `task_definition`, and `load_balancer`. This is intended to support a continuous deployment process that is responsible for updating the `image` and therefore the `task_definition` and `container_definition` while avoiding conflicts with Terraform.
7877
- Amazon ECS task resources with the various configurations detailed below under [ECS Task](https://github.com/terraform-aws-modules/terraform-aws-ecs/blob/master/docs/README.md#ecs-task)
7978

8079
Since Terraform does not support variables within `lifecycle {}` blocks, its not possible to allow users to dynamically select which arguments they wish to ignore within the resources defined in the modules. Therefore, any arguments that should be ignored are statically set within the module definition. To somewhat mimic the behavior of allowing users to opt in/out of ignoring certain arguments, the module supports three different service definitions; one that ignores the `desired_count`, and one that ignores the `desired_count` and `task_definition` and one that ignores `desired_count`, `task_definition` and `load_balancer`. The motivation and reasoning for these ignored argument configurations is detailed below:

wrappers/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This wrapper does not implement any extra functionality.
1212

1313
```hcl
1414
terraform {
15-
source = "tfr:///terraform-aws-modules/pr/aws//wrappers"
15+
source = "tfr:///terraform-aws-modules/ecs/aws//wrappers"
1616
# Alternative source:
17-
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-pr.git//wrappers?ref=master"
17+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-ecs.git//wrappers?ref=master"
1818
}
1919
2020
inputs = {
@@ -42,7 +42,7 @@ inputs = {
4242

4343
```hcl
4444
module "wrapper" {
45-
source = "terraform-aws-modules/pr/aws//wrappers"
45+
source = "terraform-aws-modules/ecs/aws//wrappers"
4646
4747
defaults = { # Default values
4848
create = true

wrappers/cluster/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This wrapper does not implement any extra functionality.
1212

1313
```hcl
1414
terraform {
15-
source = "tfr:///terraform-aws-modules/pr/aws//wrappers/cluster"
15+
source = "tfr:///terraform-aws-modules/ecs/aws//wrappers/cluster"
1616
# Alternative source:
17-
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-pr.git//wrappers/cluster?ref=master"
17+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-ecs.git//wrappers/cluster?ref=master"
1818
}
1919
2020
inputs = {
@@ -42,7 +42,7 @@ inputs = {
4242

4343
```hcl
4444
module "wrapper" {
45-
source = "terraform-aws-modules/pr/aws//wrappers/cluster"
45+
source = "terraform-aws-modules/ecs/aws//wrappers/cluster"
4646
4747
defaults = { # Default values
4848
create = true

wrappers/container-definition/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This wrapper does not implement any extra functionality.
1212

1313
```hcl
1414
terraform {
15-
source = "tfr:///terraform-aws-modules/pr/aws//wrappers/container-definition"
15+
source = "tfr:///terraform-aws-modules/ecs/aws//wrappers/container-definition"
1616
# Alternative source:
17-
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-pr.git//wrappers/container-definition?ref=master"
17+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-ecs.git//wrappers/container-definition?ref=master"
1818
}
1919
2020
inputs = {
@@ -42,7 +42,7 @@ inputs = {
4242

4343
```hcl
4444
module "wrapper" {
45-
source = "terraform-aws-modules/pr/aws//wrappers/container-definition"
45+
source = "terraform-aws-modules/ecs/aws//wrappers/container-definition"
4646
4747
defaults = { # Default values
4848
create = true

wrappers/service/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This wrapper does not implement any extra functionality.
1212

1313
```hcl
1414
terraform {
15-
source = "tfr:///terraform-aws-modules/pr/aws//wrappers/service"
15+
source = "tfr:///terraform-aws-modules/ecs/aws//wrappers/service"
1616
# Alternative source:
17-
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-pr.git//wrappers/service?ref=master"
17+
# source = "git::[email protected]:terraform-aws-modules/terraform-aws-ecs.git//wrappers/service?ref=master"
1818
}
1919
2020
inputs = {
@@ -42,7 +42,7 @@ inputs = {
4242

4343
```hcl
4444
module "wrapper" {
45-
source = "terraform-aws-modules/pr/aws//wrappers/service"
45+
source = "terraform-aws-modules/ecs/aws//wrappers/service"
4646
4747
defaults = { # Default values
4848
create = true

0 commit comments

Comments
 (0)