Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resource/aws_ecs_task_definition: prevent spurious container definition diffs #36029

Merged

Conversation

ilkansh8
Copy link
Contributor

@ilkansh8 ilkansh8 commented Feb 29, 2024

Description

When the order of the container definitions does not match between AWS API and aws_ecs_task_definition, terraform tries to replace the task definition to match the container definitions order. This is unnecessary as the container order does not mean anything.

I am trying to to import bunch of different task definitions using a single module, and I keep getting diffs due to container definitions order. This PR prevents unnecessary diffs for when the container definitions order does not match between API and Terraform.

resource "aws_ecs_task_definition" "test" {
    family = "testtaskdef1"
    container_definitions = jsonencode([
        {
            "name": "sidecard",
            "image": "sidecar:1",
            "cpu": 0,
            "portMappings": [],
            "essential": false,
            "environment": [
                {
                    "name": "sidecarenv",
                    "value": "sidecarenvvalue"
                },
                {
                    "name": "sidecarenv2",
                    "value": "sidecarenvvalue"
                }
            ],
            "environmentFiles": [],
            "mountPoints": [],
            "volumesFrom": [],
            "systemControls": []
        },
        {
            "name": "app",
            "image": "busybox:1",
            "cpu": 0,
            "portMappings": [
                {
                    "name": "app-80-tcp",
                    "containerPort": 80,
                    "hostPort": 80,
                    "protocol": "tcp",
                    "appProtocol": "http"
                }
            ],
            "essential": true,
            "environment": [
                {
                    "name": "appenv",
                    "value": "appenvvalue"
                }
            ],
            "environmentFiles": [],
            "mountPoints": [],
            "volumesFrom": [],
            "ulimits": [],
            "systemControls": []
        }
      ])
}
  # aws_ecs_task_definition.test must be replaced
  # (imported from "arn:aws:ecs:eu-central-1:zz:task-definition/testtaskdef1:2")
  # Warning: this will destroy the imported resource
-/+ resource "aws_ecs_task_definition" "test" {
      ~ arn                      = "arn:aws:ecs:eu-central-1:zz:task-definition/testtaskdef1:2" -> (known after apply)
      ~ arn_without_revision     = "arn:aws:ecs:eu-central-1:zz:task-definition/testtaskdef1" -> (known after apply)
      ~ container_definitions    = jsonencode(
          ~ [
              - {
                  - cpu              = 0
                  - environment      = [
                      - {
                          - name  = "appenv"
                          - value = "appenvvalue"
                        },
                    ]
                  - environmentFiles = []
                  - essential        = true
                  - image            = "busybox:1"
                  - mountPoints      = []
                  - name             = "app"
                  - portMappings     = [
                      - {
                          - appProtocol   = "http"
                          - containerPort = 80
                          - hostPort      = 80
                          - name          = "app-80-tcp"
                          - protocol      = "tcp"
                        },
                    ]
                  - systemControls   = []
                  - ulimits          = []
                  - volumesFrom      = []
                },
                {
                    cpu              = 0
                    environment      = [
                        {
                            name  = "sidecarenv"
                            value = "sidecarenvvalue"
                        },
                    ]
                    environmentFiles = []
                    essential        = false
                    image            = "sidecar:1"
                    mountPoints      = []
                    name             = "sidecard"
                    portMappings     = []
                    systemControls   = []
                    volumesFrom      = []
                },
              + {
                  + cpu              = 0
                  + environment      = [
                      + {
                          + name  = "appenv"
                          + value = "appenvvalue"
                        },
                    ]
                  + environmentFiles = []
                  + essential        = true
                  + image            = "busybox:1"
                  + mountPoints      = []
                  + name             = "app"
                  + portMappings     = [
                      + {
                          + appProtocol   = "http"
                          + containerPort = 80
                          + hostPort      = 80
                          + name          = "app-80-tcp"
                          + protocol      = "tcp"
                        },
                    ]
                  + systemControls   = []
                  + ulimits          = []
                  + volumesFrom      = []
                },
            ] # forces replacement
        )

Relations

Relates #11463.
Relates #35792.

Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/XS Managed by automation to categorize the size of a PR. service/ecs Issues and PRs that pertain to the ecs service. labels Feb 29, 2024
@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Feb 29, 2024
@ewbankkit ewbankkit added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Feb 29, 2024
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccECSTaskDefinition_basic' PKG=ecs
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ecs/... -v -count 1 -parallel 20  -run=TestAccECSTaskDefinition_basic -timeout 360m
=== RUN   TestAccECSTaskDefinition_basic
=== PAUSE TestAccECSTaskDefinition_basic
=== CONT  TestAccECSTaskDefinition_basic
--- PASS: TestAccECSTaskDefinition_basic (30.80s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/ecs	38.830s

@ewbankkit
Copy link
Contributor

@ilkansh8 Thanks for the contribution 🎉 👏.

@ewbankkit ewbankkit merged commit 32dd4e1 into hashicorp:main Feb 29, 2024
33 checks passed
@github-actions github-actions bot added this to the v5.39.0 milestone Feb 29, 2024
Copy link

github-actions bot commented Mar 1, 2024

This functionality has been released in v5.39.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Addresses a defect in current functionality. service/ecs Issues and PRs that pertain to the ecs service. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants