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): require task pidMode for Linux-based Fargate tasks, not host #30020

Merged
merged 12 commits into from May 10, 2024

Conversation

CharlesHolmes
Copy link
Contributor

@CharlesHolmes CharlesHolmes commented Apr 30, 2024

Issue # (if applicable)

Closes #29995.

Reason for this change

Only the task option is allowed for pidMode on Linux-based Fargate tasks.

Description of changes

This PR builds on the changes introduced in #29670 but fixes the handling of pidMode so that it matches the behavior allowed by CloudFormation and described in the AWS User Guide.

Description of how you validated changes

Updated the existing tests so that task is the only allowable pidMode setting if a Fargate task's OS is Linux-based.

Checklist


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 bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Apr 30, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team April 30, 2024 21:45
@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Apr 30, 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 Apr 30, 2024
@vduits
Copy link

vduits commented May 1, 2024

Appreciate the fix. I see you also added a check for it being a linux os family, which makes sense being the alternative already being present for denying pidmode usage. Though that does change the behavior, where it will now only warn when you set an OS family, I think that is a good thing as it's more consistent to only message on knowns.

It does however mean that without an os family you have to will wait until deployment to notice your mistake. If we want a synth level protection, then it would be better to also lock pidmode behind having set an os family. Your current changes mean that if you set PidMode.HOST on a non os family tagged resource, it will synth but fail on deployment. (And I guess if any are used on windows one)

@CharlesHolmes
Copy link
Contributor Author

CharlesHolmes commented May 1, 2024

If we want a synth level protection, then it would be better to also lock pidmode behind having set an os family.

I like this because it only affects people who are already using the L2 pidMode (which was introduced only a few days ago) and only if they're not specifying an OS family. I'll put together the change.

Edit - In fact, because the existing pidMode functionality will fail on deployment (because host isn't allowed on Linux Fargate tasks), this shouldn't have any impact on existing code.

@xazhao xazhao self-assigned this May 8, 2024
Copy link
Contributor

@xazhao xazhao left a comment

Choose a reason for hiding this comment

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

Agree that it's not a breaking change because the deployment would fail with wrong pidMode value before. Left some nit comments

@CharlesHolmes CharlesHolmes requested a review from xazhao May 10, 2024 15:41
Copy link
Contributor

mergify bot commented May 10, 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).

@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 May 10, 2024
Copy link
Contributor

mergify bot commented May 10, 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 3e9e0a8 into aws:main May 10, 2024
9 checks passed
Copy link
Contributor

mergify bot commented May 10, 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).

@CharlesHolmes CharlesHolmes deleted the fargate-pidmode-task branch May 10, 2024 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws_ecs.FargateTaskDefinition: pidmode Task unsupported
4 participants