(ecs): Can't update FargateService with CODE_DEPLOY deploymentController

[sergeivalko]

Describe the bug

When i update properties related to a service like desiredCount or any allowed cloudformation throws an exception

Expected Behavior

Service updated

Current Behavior

Error: Unable to update task definition on services with a CODE_DEPLOY deployment controller. Use AWS CodeDeploy to trigger a new deployment

Reproduction Steps

    const taskDefinition = new ecs.FargateTaskDefinition(
      this,
      'TaskDefinition',
      {
        family: family,
        taskRole,
        executionRole,
      }
    );

    const logGroup = logs.LogGroup.fromLogGroupName(
      this,
      'DockerLogGroup',
      'docker_logs'
    );

    taskDefinition.addContainer('ServiceContainer', {
      containerName: props.serviceName,
      portMappings: [{ containerPort: 5000, hostPort: 5000 }],
      logging: ecs.LogDrivers.awsLogs({
        streamPrefix: `${props.serviceName}-`,
        logGroup,
      }),
      image: ecs.ContainerImage.fromRegistry(props.image),
    });

    taskDefinition.applyRemovalPolicy(cdk.RemovalPolicy.RETAIN);

    // Create Service
    const service = new ecs.FargateService(this, 'Service', {
      cluster,
      deploymentController: {
        type: ecs.DeploymentControllerType.CODE_DEPLOY,
      },
      taskDefinition: taskDefinition,
      healthCheckGracePeriod: cdk.Duration.seconds(0),
      serviceName: props.serviceName,
      securityGroups: [securityGroup],
      vpcSubnets: {
        subnets: subnets.map((value, index) =>
          ec2.Subnet.fromSubnetId(this, `Subnet${index + 1}`, value)
        ),
      },
      ...props.service,
    });

Possible Solution

Modify request UpdateService

Additional Information/Context

I found the Update Service event and it looks like the cloudformation also sent other information like taskDefinition, network, etc in the requestParameters and I think that's not correct.

cdk diff:

CDK CLI Version

2.59.0

Framework Version

No response

Node.js Version

v14.18.0

OS

Windows

Language

Typescript

Language Version

4.9.4

Other information

No response

[sergeivalko]

@cplee @clareliguori Any ideas?

[cplee]

@sergeivalko What does the CloudFormation changeset look like for the ECS service?

[sergeivalko]

@cplee

[
  {
    "resourceChange": {
      "logicalResourceId": "DeploymentGroup6D277AF0",
      "action": "Modify",
      "physicalResourceId": "default",
      "resourceType": "AWS::CodeDeploy::DeploymentGroup",
      "replacement": "False",
      "moduleInfo": null,
      "details": [
        {
          "target": {
            "name": "ECSServices",
            "requiresRecreation": "Never",
            "attribute": "Properties"
          },
          "causingEntity": "ServiceD69D759B.Name",
          "evaluation": "Dynamic",
          "changeSource": "ResourceAttribute"
        }
      ],
      "changeSetId": null,
      "scope": [
        "Properties"
      ]
    },
    "hookInvocationCount": null,
    "type": "Resource"
  },
  {
    "resourceChange": {
      "logicalResourceId": "ServiceD69D759B",
      "action": "Modify",
      "physicalResourceId": "[ARN]-service/n2p-uniteplatform-dev/n2p-unite-call-queue-metrics-service",
      "resourceType": "AWS::ECS::Service",
      "replacement": "False",
      "moduleInfo": null,
      "details": [
        {
          "target": {
            "name": "DesiredCount",
            "requiresRecreation": "Never",
            "attribute": "Properties"
          },
          "causingEntity": null,
          "evaluation": "Static",
          "changeSource": "DirectModification"
        }
      ],
      "changeSetId": null,
      "scope": [
        "Properties"
      ]
    },
    "hookInvocationCount": null,
    "type": "Resource"
  },
  {
    "resourceChange": {
      "logicalResourceId": "ServiceTaskCountTarget23E25614",
      "action": "Modify",
      "physicalResourceId": "service/n2p-uniteplatform-dev/n2p-unite-call-queue-metrics-service|ecs:service:DesiredCount|ecs",
      "resourceType": "AWS::ApplicationAutoScaling::ScalableTarget",
      "replacement": "Conditional",
      "moduleInfo": null,
      "details": [
        {
          "target": {
            "name": "ResourceId",
            "requiresRecreation": "Always",
            "attribute": "Properties"
          },
          "causingEntity": "ServiceD69D759B.Name",
          "evaluation": "Dynamic",
          "changeSource": "ResourceAttribute"
        }
      ],
      "changeSetId": null,
      "scope": [
        "Properties"
      ]
    },
    "hookInvocationCount": null,
    "type": "Resource"
  }
]

[sergeivalko]

@cplee Did you manage to reproduce?

[pahud]

Does it only happen when you specify the deploymentController prop?

deploymentController: {
        type: ecs.DeploymentControllerType.CODE_DEPLOY,
      },

[sergeivalko]

@pahud i'll check and let you know.

[sergeivalko]

@pahud yes, it only happens when i specify deploymentController prop as CODE_DEPLOY

[clareliguori]

Hello @sergeivalko, please open an issue in the CloudFormation coverage roadmap - this is an issue with the way that CloudFormation handles ECS service updates, not an issue with CDK. As you stated, the CloudFormation handler always fills in all parameters in the ECS UpdateService API call, regardless of whether those values have changed in the current changeset. When the CODE_DEPLOY deployment controller is used, ECS UpdateService API calls will be rejected if the network configuration, platform version, task definition, or load balancer is provided in the call.

[sergeivalko]

@clareliguori Hello, thanks, done aws-cloudformation/cloudformation-coverage-roadmap#1529

[pahud]

Thank you @clareliguori for clarifying. I am closing this now as it is not relevant to CDK. Feel free to re-open if necessary.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[ankit-agrawal-berlin]

Does anyone has a workaround?

[nicoalonsop]

@ankit-agrawal-berlin Still happening to me and the issue was created on CloudFormation coverage roadmap #1529 6 months ago as @clareliguori suggested, but it was closed 2 months ago by a bot, and last week was reopened without any comment from AWS at all.

@clareliguori Is it possible for you to tag someone from AWS on that issue? I would love to see some updates if possible.