feat(ecs): warning when creating a service with the default minHealthyPercent by MarrickLip · Pull Request #31738 · aws/aws-cdk

MarrickLip · 2024-10-12T07:04:24Z

Issue

Reason for this change

CDK overrides the default value of 100% used by CloudFormation's AWS::ECS::Service and the CreateService API. This allows the number of running tasks to drop by up to 50% during deployments and Fargate maintenance etc.

This is an unsafe default for services which must support a consistent load e.g. handle web traffic via an ALB.

Description of changes

A warning appears when the default value is implicitly used. CloudFormation's default is overridden in three different places so multiple warnings are added:

BaseService emits @aws-cdk/aws-ecs:minHealthyPercent when minHealthyPercent is undefined
Ec2Service emits @aws-cdk/aws-ecs:minHealthyPercentDaemon when daemon is true and minHealthyPercent is undefined
ExternalService emits @aws-cdk/aws-ecs:minHealthyPercentExternal when minHealthyPercent is undefined

At most one warning appears due to the way the CloudFormation's default is overidden.

README.md has been updated for aws_ecs and aws_ecs_patterns to ensure these examples don't trigger this warning.

Description of how you validated changes

Unit tests have been added to ensure the warnings appear are there when they should be and not when they shouldn't.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

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.

…laced

MarrickLip · 2024-10-12T13:21:28Z

The pull request linter fails with the following errors:
❌ Features must contain a change to an integration test file and the resulting snapshot.
PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

Exemption Request: warning doesn't change synthesized CloudFormation stacks so new integration tests not required.

godwingrs22

@MarrickLip Thanks for your contribution. LGTM.

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

mergify · 2025-01-06T23:53:58Z

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).

godwingrs22 · 2025-01-07T17:50:42Z

@mergify update

mergify · 2025-01-07T17:50:52Z

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/codecov.yml without workflows permission

Pull request has been modified.

aws-cdk-automation · 2025-01-07T18:28:37Z

AWS CodeBuild CI Report

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

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

mergify · 2025-01-07T18:59:32Z

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 · 2025-01-07T19:04:21Z

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).

codecov · 2025-01-07T19:23:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.52%. Comparing base (c57debb) to head (a50f5b3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #31738   +/-   ##
=======================================
  Coverage   81.52%   81.52%           
=======================================
  Files         222      222           
  Lines       13715    13715           
  Branches     2417     2417           
=======================================
  Hits        11181    11181           
  Misses       2254     2254           
  Partials      280      280

Flag	Coverage Δ
suite.unit	`81.52% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.97% <ø> (ø)`
packages/aws-cdk-lib/core	`82.09% <ø> (ø)`

godwingrs22 · 2025-01-07T19:24:09Z

@Mergifyio update

mergify · 2025-01-07T19:24:14Z

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: user doesn't have permission to update head repository

github-actions · 2025-01-07T19:24:28Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

MarrickLip added 8 commits October 12, 2024 15:13

add warning if BaseService created with minHealthyPercent undefined

925d76d

add tests to FargateService and Ec2Service

349944d

add warning and test for Ec2Service for daemon services specifically

ed398fe

rever aws-cdk.code-workspace

41e295f

revert aws-cdk.code-workspace

85d0c76

update aws-ecs/README.md examples to not generate warnings

15e6a0c

update aws-ecs-patterns/README.md examples to not generate warnings

a10c2b6

implement warning and tests for external services

3b3d354

aws-cdk-automation requested a review from a team October 12, 2024 07:04

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Oct 12, 2024

MarrickLip changed the title ~~feat (~~ feat(aws-ecs): warning when creating a service with the default minHealthyPercent Oct 12, 2024

aws-cdk-automation previously requested changes Oct 12, 2024

View reviewed changes

MarrickLip changed the title ~~feat(aws-ecs): warning when creating a service with the default minHealthyPercent~~ feat(ecs): warning when creating a service with the default minHealthyPercent Oct 12, 2024

fix linting issue

afddde3

aws-cdk-automation added pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Oct 12, 2024

MarrickLip added 2 commits October 12, 2024 23:11

fix aws_ecs_patterns README having minHealthyPercent in unsupported p…

6c9063a

…laced

fix aws_ecs_patterns README having minHealthyPercent in unsupported p…

6af52c8

…laced

aws-cdk-automation added pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Oct 12, 2024

github-actions bot mentioned this pull request Nov 1, 2024

Monthly PR metrics report #31972

Closed

gracelu0 removed the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Dec 30, 2024

godwingrs22 added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jan 6, 2025

godwingrs22 previously approved these changes Jan 6, 2025

View reviewed changes

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 6, 2025

Merge branch 'main' into minimum-healthy-percent-warning

a50f5b3

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 7, 2025

godwingrs22 approved these changes Jan 7, 2025

View reviewed changes

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 7, 2025

mergify bot merged commit 3606deb into aws:main Jan 7, 2025

github-actions bot locked as resolved and limited conversation to collaborators Jan 7, 2025

Conversation

MarrickLip commented Oct 12, 2024

Issue

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

MarrickLip commented Oct 12, 2024

Uh oh!

godwingrs22 left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Jan 6, 2025

Uh oh!

godwingrs22 commented Jan 7, 2025

Uh oh!

mergify bot commented Jan 7, 2025

❌ Mergify doesn't have permission to update

Uh oh!

aws-cdk-automation commented Jan 7, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Jan 7, 2025

Uh oh!

mergify bot commented Jan 7, 2025

Uh oh!

codecov bot commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

godwingrs22 commented Jan 7, 2025

Uh oh!

mergify bot commented Jan 7, 2025

❌ Mergify doesn't have permission to update

Uh oh!

github-actions bot commented Jan 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Jan 7, 2025 •

edited

Loading