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

fix(ecs): removed explicit addition of ecs deployment type when circuit breaker is enabled #22328

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions packages/@aws-cdk/aws-ecs-patterns/test/ec2/l3s.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1573,9 +1573,6 @@ test('ALB with circuit breaker', () => {
Rollback: true,
},
},
DeploymentController: {
Type: 'ECS',
},
});
});

Expand Down Expand Up @@ -1610,9 +1607,6 @@ test('NLB with circuit breaker', () => {
Rollback: true,
},
},
DeploymentController: {
Type: 'ECS',
},
});
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,6 @@ testDeprecated('test ECS queue worker service construct - with optional props',
},
LaunchType: 'EC2',
ServiceName: 'ecs-test-service',
DeploymentController: {
Type: 'ECS',
},
PlacementConstraints: [{ Type: 'memberOf', Expression: 'attribute:ecs.instance-type =~ m5a.*' }],
PlacementStrategies: [{ Field: 'instanceId', Type: 'spread' }, { Field: 'CPU', Type: 'binpack' }, { Type: 'random' }],
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,11 @@
},
"DeploymentConfiguration": {
"MaximumPercent": 200,
"MinimumHealthyPercent": 50
"MinimumHealthyPercent": 50,
"DeploymentCircuitBreaker": {
"Enable": true,
"Rollback": true
}
},
"EnableECSManagedTags": true,
"EnableExecuteCommand": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -634,9 +634,6 @@
"MaximumPercent": 200,
"MinimumHealthyPercent": 50
},
"DeploymentController": {
"Type": "ECS"
},
"EnableECSManagedTags": false,
"HealthCheckGracePeriodSeconds": 60,
"LaunchType": "FARGATE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1121,9 +1121,6 @@
"rollback": true
}
},
"deploymentController": {
"type": "ECS"
},
"enableEcsManagedTags": false,
"healthCheckGracePeriodSeconds": 60,
"launchType": "FARGATE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -621,9 +621,6 @@
"MaximumPercent": 200,
"MinimumHealthyPercent": 50
},
"DeploymentController": {
"Type": "ECS"
},
"EnableECSManagedTags": false,
"LaunchType": "FARGATE",
"NetworkConfiguration": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1107,9 +1107,6 @@
"rollback": true
}
},
"deploymentController": {
"type": "ECS"
},
"enableEcsManagedTags": false,
"launchType": "FARGATE",
"networkConfiguration": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ new ApplicationLoadBalancedFargateService(stack, 'myService', {
zoneName: 'example.com.',
}),
redirectHTTP: true,
circuitBreaker: { rollback: true },
});

new integ.IntegTest(app, 'albFargateServiceTest', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -451,9 +451,6 @@ test('setting ALB circuitBreaker works', () => {
Rollback: true,
},
},
DeploymentController: {
Type: 'ECS',
},
});
});

Expand All @@ -477,9 +474,6 @@ test('setting NLB circuitBreaker works', () => {
Rollback: true,
},
},
DeploymentController: {
Type: 'ECS',
},
});
});

Expand Down Expand Up @@ -1165,4 +1159,4 @@ test('NetworkLoadBalancedFargateService multiple capacity provider strategies ar
},
]),
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -446,9 +446,6 @@ testDeprecated('test Fargate queue worker service construct - with optional prop
LaunchType: 'FARGATE',
ServiceName: 'fargate-test-service',
PlatformVersion: ecs.FargatePlatformVersion.VERSION1_4,
DeploymentController: {
Type: 'ECS',
},
});

Template.fromStack(stack).hasResourceProperties('AWS::SQS::Queue', { QueueName: 'fargate-test-sqs-queue' });
Expand Down
8 changes: 4 additions & 4 deletions packages/@aws-cdk/aws-ecs/lib/base/base-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -449,9 +449,7 @@ export abstract class BaseService extends Resource
},
propagateTags: propagateTagsFromSource === PropagatedTagSource.NONE ? undefined : props.propagateTags,
enableEcsManagedTags: props.enableECSManagedTags ?? false,
deploymentController: props.circuitBreaker ? {
type: DeploymentControllerType.ECS,
} : props.deploymentController,
deploymentController: props.deploymentController,
launchType: launchType,
enableExecuteCommand: props.enableExecuteCommand,
capacityProviderStrategy: props.capacityProviderStrategies,
Expand All @@ -465,7 +463,9 @@ export abstract class BaseService extends Resource
if (props.deploymentController?.type === DeploymentControllerType.EXTERNAL) {
Annotations.of(this).addWarning('taskDefinition and launchType are blanked out when using external deployment controller.');
}

if (props.circuitBreaker && props.deploymentController?.type !== DeploymentControllerType.ECS) {
Annotations.of(this).addError('Deployment circuit breaker requires the ECS deployment controller.');
}
this.serviceArn = this.getResourceArnAttribute(this.resource.ref, {
service: 'ecs',
resource: 'service',
Expand Down
30 changes: 30 additions & 0 deletions packages/@aws-cdk/aws-ecs/test/ec2/ec2-service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,36 @@ describe('ec2 service', () => {

});


test('add warning to annotations if circuitBreaker is specified with a non-ECS DeploymentControllerType', () => {
// GIVEN
const stack = new cdk.Stack();
const vpc = new ec2.Vpc(stack, 'MyVpc', {});
const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
addDefaultCapacityProvider(cluster, stack, vpc);
const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'Ec2TaskDef');

taskDefinition.addContainer('web', {
image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
memoryLimitMiB: 512,
});

const service = new ecs.Ec2Service(stack, 'Ec2Service', {
cluster,
taskDefinition,
deploymentController: {
type: DeploymentControllerType.EXTERNAL,
},
circuitBreaker: { rollback: true },
});

// THEN
expect(service.node.metadata[0].data).toEqual('taskDefinition and launchType are blanked out when using external deployment controller.');
expect(service.node.metadata[1].data).toEqual('Deployment circuit breaker requires the ECS deployment controller.');

});


test('errors if daemon and desiredCount both specified', () => {
// GIVEN
const stack = new cdk.Stack();
Expand Down
29 changes: 28 additions & 1 deletion packages/@aws-cdk/aws-ecs/test/external/external-service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';
import * as cloudmap from '@aws-cdk/aws-servicediscovery';
import * as cdk from '@aws-cdk/core';
import * as ecs from '../../lib';
import { LaunchType } from '../../lib/base/base-service';
import { DeploymentControllerType, LaunchType } from '../../lib/base/base-service';
import { addDefaultCapacityProvider } from '../util';

describe('external service', () => {
Expand Down Expand Up @@ -520,7 +520,34 @@ describe('external service', () => {
containerPort: 8000,
})).toThrow('Cloud map service association is not supported for an external service');


});

test('add warning to annotations if circuitBreaker is specified with a non-ECS DeploymentControllerType', () => {
// GIVEN
const stack = new cdk.Stack();
const vpc = new ec2.Vpc(stack, 'MyVpc', {});
const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
addDefaultCapacityProvider(cluster, stack, vpc);
const taskDefinition = new ecs.ExternalTaskDefinition(stack, 'TaskDef');

taskDefinition.addContainer('web', {
image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
memoryLimitMiB: 512,
});

const service = new ecs.ExternalService(stack, 'ExternalService', {
cluster,
taskDefinition,
deploymentController: {
type: DeploymentControllerType.EXTERNAL,
},
circuitBreaker: { rollback: true },
});

// THEN
expect(service.node.metadata[0].data).toEqual('taskDefinition and launchType are blanked out when using external deployment controller.');
expect(service.node.metadata[1].data).toEqual('Deployment circuit breaker requires the ECS deployment controller.');

});
});
30 changes: 27 additions & 3 deletions packages/@aws-cdk/aws-ecs/test/fargate/fargate-service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,33 @@ describe('fargate service', () => {
});
});

test('add warning to annotations if circuitBreaker is specified with a non-ECS DeploymentControllerType', () => {
// GIVEN
const stack = new cdk.Stack();
const vpc = new ec2.Vpc(stack, 'MyVpc', {});
const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
const taskDefinition = new ecs.FargateTaskDefinition(stack, 'FargateTaskDef');

taskDefinition.addContainer('web', {
image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
});

const service = new ecs.FargateService(stack, 'FargateService', {
cluster,
taskDefinition,
deploymentController: {
type: DeploymentControllerType.EXTERNAL,
},
circuitBreaker: { rollback: true },
});

// THEN
expect(service.node.metadata[0].data).toEqual('taskDefinition and launchType are blanked out when using external deployment controller.');
expect(service.node.metadata[1].data).toEqual('Deployment circuit breaker requires the ECS deployment controller.');

});


test('errors when no container specified on task definition', () => {
// GIVEN
const stack = new cdk.Stack();
Expand Down Expand Up @@ -2416,9 +2443,6 @@ describe('fargate service', () => {
Rollback: true,
},
},
DeploymentController: {
Type: ecs.DeploymentControllerType.ECS,
},
});
});

Expand Down