FargateService trying to update ECS service when CODE_DEPLOY used

The FargateService class is trying to update the ECS Service when a new task definition is provided to the service when DeploymentControllerType.CODE_DEPLOY is specified. When using Blue/Green deployment strategy powered by CodeDeploy in a Fargate Service, only the desired count, deployment configuration, and health check grace period can be updated using the update-service. Otherwise a new CodeDeploy deployment should be created. So I haven’t been able to do any deploy on production environment with CDK since I use CODE_DEPLOY.

Reproduction Steps

new FargateService(
            this,
            "FargateService",
            FargateServiceProps
                .builder()
                .cluster(this.props.cluster)
                .serviceName(this.getPrefixResourceName())
                .assignPublicIp(false)
                .desiredCount(this.props.desiredCount)
                .healthCheckGracePeriod(Duration.seconds(60))
                .minHealthyPercent(100)
                .maxHealthyPercent(200)
                .taskDefinition(this.taskDefinition)
                .securityGroup(this.securityGroup)
                .vpcSubnets(this.privateSubnets)
                .deploymentController(
                    DeploymentController
                        .builder()
                        .type(DeploymentControllerType.CODE_DEPLOY)
                        .build()
                )
                .cloudMapOptions(
                    CloudMapOptions
                        .builder()
                        .name(this.getPrefixResourceName())
                        .cloudMapNamespace(this.props.serviceDiscoveryNamespace)
                        .dnsRecordType(DnsRecordType.A)
                        .dnsTtl(Duration.seconds(60))
                        .build()
                )
                .build()
        );

Error Log

 Unable to update task definition on services with a CODE_DEPLOY deployment controller. Use AWS CodeDeploy to trigger a new deployment. (Service: AmazonECS; Status Code: 400; Error Code: InvalidParameterException; Request ID: 83f32eb8-4ed5-4263-b944-9df4d7fa3a62)

Environment

• **CLI Version 😗*1.30.0
• **Framework Version:**1.30.0
• **OS 😗*MacOS Mojave
• **Language 😗*Java

---

This is 🐛 Bug Report

[konstantinj]

Found a workaround to be able to maintain new task definition revisions with CDK and use Code Deploy with an external CLI command.

        const taskDefinitionProps = {
            cpu: 1024,
            memoryLimitMiB: 2048,
        }

        const taskDefinition = new FargateTaskDefinition(this, 'TaskDefinition', taskDefinitionProps)

        const containerDefinitionOptions = {
            image: ContainerImage.fromEcrRepository(Repository.fromRepositoryName(this, 'Repository', 'docker'), 'latest'),
            environment: {
                NAME: 'latest',
            },
            logging: LogDriver.awsLogs({
                logGroup: logGroup,
                streamPrefix: 'docker',
            }),
        }
        const container = taskDefinition.addContainer('docker', containerDefinitionOptions)

        container.addPortMappings({
            containerPort: 80,
        })

        container.addUlimits({
            name: UlimitName.NOFILE,
            softLimit: 16384,
            hardLimit: 16384,
        })

        const service = new FargateService(this, 'Service', {
            cluster: cluster,
            healthCheckGracePeriod: Duration.seconds(60),
            minHealthyPercent: 50,
            maxHealthyPercent: 200,
            deploymentController: {
                type: DeploymentControllerType.CODE_DEPLOY,
            },
            taskDefinition: taskDefinition,
        })

        const taskDefinitionRev = new FargateTaskDefinition(this, 'TaskDefinitionNew', {
            ...taskDefinitionProps,
            family: taskDefinition.family,
        })

        const cfnTaskDefinition = taskDefinitionRev.node.defaultChild as CfnTaskDefinition
        cfnTaskDefinition.cfnOptions.updateReplacePolicy = CfnDeletionPolicy.RETAIN

        const containerRev = taskDefinitionRev.addContainer('docker', {
            ...containerDefinitionOptions,
            environment: {
                ...containerDefinitionOptions.environment,
                NAME: 'docker-new',
            },
            image: ContainerImage.fromAsset('docker'),
        })

        containerRev.addPortMappings(...container.portMappings)
        containerRev.addUlimits(...container.ulimits)

Explanation: Cloudformation would always try to update the current task definition which would lead to an immediate update of the ecs service. This is not possible (currently) when using DeploymentControllerType.CODE_DEPLOY. By adding a new task definition logical resource in the stack but giving it the same task family, Cloudformation will create a new task definition revision. The revision that is active in the ecs service must not be changed anymore. Unfortunately Cloudformation will remove old revisions. There the updateReplacePolicy needs to be set to retain.

For automating it the newly created task definition revision can be retrieved from the updated stack which can then be used in a cli call like:

aws ecs deploy ...

[MrArnoldPalmer]

Hey there, I’m consolidating the issues around ecs blue/green deployment support into https://github.com/aws/aws-cdk/issues/1559. If you think this is a separate issue feel free to reopen.