feat: enable circuit breakers by default

capralifecycle · Nov 11, 2024 · 3382091 · 3382091
1 parent 767522b
commit 3382091
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/src/ecs/__tests__/__snapshots__/fargate-service.test.ts.snap b/src/ecs/__tests__/__snapshots__/fargate-service.test.ts.snap
diff --git a/src/ecs/fargate-service.ts b/src/ecs/fargate-service.ts
@@ -56,6 +56,10 @@ export interface FargateServiceProps {
    * @default false
    */
   skipTargetGroup?: boolean
+  /**
+   * @default true
+   */
+  enableCircuitBreaker?: boolean
 }
 
 export class FargateService extends constructs.Construct {
@@ -72,6 +76,16 @@ export class FargateService extends constructs.Construct {
   ) {
     super(scope, id)
 
+    /**
+     * Set this flag to disable this stack creating a completely new service and attempting replace when enabling circuit breakers
+     * Mitigating the deploytment error: 'a service with the name <...> already exists'
+     * See: github.com/aws/aws-cdk/pull/22467
+     */
+    this.node.setContext(
+      "@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker",
+      true,
+    )
+
     const parameters = new ConfigureParameters(this, {
       ssmPrefix: `/liflig-cdk/${cdk.Stack.of(this).stackName}/${
         this.node.addr
@@ -125,6 +139,8 @@ export class FargateService extends constructs.Construct {
       hostPort: port,
     })
 
+    const enableCircuitBreaker = props.enableCircuitBreaker ?? true
+
     this.fargateService = new ecs.FargateService(this, "Service", {
       serviceName: props.serviceName,
       vpcSubnets: {
@@ -139,6 +155,12 @@ export class FargateService extends constructs.Construct {
       securityGroups: [this.securityGroup],
       platformVersion: ecs.FargatePlatformVersion.VERSION1_4,
       enableExecuteCommand: true,
+      circuitBreaker: enableCircuitBreaker
+        ? {
+            enable: true,
+            rollback: true,
+          }
+        : undefined,
       ...props.overrideFargateServiceProps,
     })