Skip to content

feat(ecs): support for explicit activation of the circuit breaker#28611

Merged
mergify[bot] merged 15 commits intoaws:mainfrom
badmintoncryer:27131-circuitBreaker
Jan 23, 2024
Merged

feat(ecs): support for explicit activation of the circuit breaker#28611
mergify[bot] merged 15 commits intoaws:mainfrom
badmintoncryer:27131-circuitBreaker

Conversation

@badmintoncryer
Copy link
Copy Markdown
Contributor

@badmintoncryer badmintoncryer commented Jan 8, 2024 •
edited
Loading

This PR has enabled explicit disabling of the circuit breaker.

declare const cluster: ecs.Cluster;
declare const taskDefinition: ecs.TaskDefinition;
const service = new ecs.FargateService(this, 'Service', {
  cluster,
  taskDefinition,
  circuitBreaker: {
    enable: true, // added
    rollback: true
  },
});

This is useful for removing a circuit breaker that has been set previously.

Closes #27131.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added valued-contributor [Pilot] contributed between 6-12 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Jan 8, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 8, 2024 11:22
aws-cdk-automation
aws-cdk-automation previously requested changes Jan 8, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 8, 2024 11:59

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@badmintoncryer badmintoncryer marked this pull request as ready for review January 8, 2024 11:59
@badmintoncryer badmintoncryer changed the title feat(ecs): support for disable circuit breaker feat(ecs): support for explicit activation of the circuit breaker Jan 8, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 8, 2024
lpizzinidev
lpizzinidev suggested changes Jan 9, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@lpizzinidev lpizzinidev left a comment

Choose a reason for hiding this comment

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

Looks good overall 👍
Just some minor documentation adjustments.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 9, 2024
badmintoncryer and others added 4 commits January 9, 2024 22:50
@badmintoncryer @lpizzinidev
Update packages/aws-cdk-lib/aws-ecs/lib/base/base-service.ts
3e90977 
Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>
@badmintoncryer @lpizzinidev
Update packages/aws-cdk-lib/aws-ecs/lib/base/base-service.ts
a3f4fa1 
Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>
@badmintoncryer @lpizzinidev
Update packages/aws-cdk-lib/aws-ecs/README.md
044682d 
Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>
@badmintoncryer
Merge branch 'main' into 27131-circuitBreaker
ea6a2a3
@badmintoncryer
Copy link
Copy Markdown
Contributor Author

badmintoncryer commented Jan 9, 2024

@lpizzinidev Thank you for your review and suggestion. I updated documentation.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 10, 2024
paulhcsun
paulhcsun reviewed Jan 22, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

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

Overall looks good, just one question about the README.

packages/aws-cdk-lib/aws-ecs/README.md Outdated
Use `circuitBreaker` to enable the deployment circuit breaker which determines whether a service deployment
will fail if the service can't reach a steady state.
You can optionally enable `rollback` for automatic rollback.
You can disable the circuit breaker by omitting the `circuitBreaker` property or setting `enabled` to `false`.
Copy link
Copy Markdown
Contributor

@paulhcsun paulhcsun Jan 22, 2024

Choose a reason for hiding this comment

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

Is this accurate that omitting the circuitBreaker property will disable the circuit breaker? I believe that was the original issue and I don't think this PR that has directly altered that behaviour.

Copy link
Copy Markdown
Contributor Author

@badmintoncryer badmintoncryer Jan 23, 2024

Choose a reason for hiding this comment

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

I think you're right. It appeared to be an unnecessary detail, so I removed it.

badmintoncryer and others added 3 commits January 23, 2024 14:45
@badmintoncryer @paulhcsun
README.md を更新
85a4f07 
Co-authored-by: paulhcsun <47882901+paulhcsun@users.noreply.github.com>
@badmintoncryer
chore: comment
b9c2304
@badmintoncryer
Merge branch 'main' into 27131-circuitBreaker
37091b4
paulhcsun
paulhcsun approved these changes Jan 23, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

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

Nice work @badmintoncryer!

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

aws-cdk-automation commented Jan 23, 2024

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: bd0dd90
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jan 23, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit bbb9555 into aws:main Jan 23, 2024
@github-actions github-actions bot mentioned this pull request Feb 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

+2 more reviewers

@lpizzinidev lpizzinidev lpizzinidev approved these changes

@paulhcsun paulhcsun paulhcsun approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

bug This issue is a bug. effort/small Small work item – less than a day of effort p2 pr/needs-maintainer-review This PR needs a review from a Core Team Member valued-contributor [Pilot] contributed between 6-12 PRs to the CDK

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

(ecs): Deployment Circuit Breaker cannot be turned off via CDK

4 participants

@badmintoncryer @aws-cdk-automation @lpizzinidev @paulhcsun