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

feat(ecs-patterns): pidmode option for fargate services #31461

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

noseworthy
Copy link

@noseworthy noseworthy commented Sep 16, 2024

Issue

Closes #31412.

Reason for this change

pidMode is an option of FargateTaskDefinition, but this was not exposed by FargateTaskDefinition which allows users to provide options for the FargateTaskDefinition that is created as part of a *FargateService when the taskDefinition property is excluded. If a user wanted to set the pidMode for their fargate tasks, it would require creating a separate FargateTaskDefinition construct and passing it to the *FargateService pattern.

Description of changes

This change exposes this option directly so that users can specify a pidMode for their tasks without having to construct a separate FargateTaskDefinition. The associated
runtimePlatform.operatingSystemFamily property which is required to be set to ecs.OperatingSystemFamily.LINUX when using pidMode was already exposed.

Description of how you validated changes

Added unit tests to ensure that the generated templates included the specified PidMode property. I've neglected to include integration tests, as I figured that the underlying FargateTaskDefinition constructs are already sufficiently tested.

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 the p2 label Sep 16, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team September 16, 2024 14:19
@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Sep 16, 2024
Copy link
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.

@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. labels Sep 16, 2024
`pidMode` is an option of `FargateTaskDefinition`, but this was not
exposed by `FargateTaskDefinition` which allows users to provide options
for the `FargateTaskDefinition` that is created as part of a
`*FargateService` when the `taskDefinition` property is excluded. If a
user wanted to set the `pidMode` for their fargate tasks, it would
require creating a separate `FargateTaskDefinition` construct and
passing it to the `*FargateService` pattern.

This change exposes this option directly so that users can specify a
`pidMode` for their tasks without having to construct a separate
`FargateTaskDefinition`. The associated
`runtimePlatform.operatingSystemFamily` property which is required to be
set to `ecs.OperatingSystemFamily.LINUX` when using `pidMode` was already
exposed.

Closes: aws#31412
@noseworthy noseworthy changed the title feat(aws-ecs-patterns): pidmode option for fargate services feat(ecs-patterns): pidmode option for fargate services Sep 16, 2024
@noseworthy
Copy link
Author

Exemption Request

Is it possible to get an exemption request for the integration test? This option already exists in the underlying constructs, and this PR just exposes it for convenience to the constructs in aws-ecs-patterns. Presumably if this change generates a valid FargateTaskDefinition as tested by the unit test, the existing integration tests for FargateTaskDefinition should cover this? Thanks for your consideration!

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Sep 16, 2024
@aws-cdk-automation
Copy link
Collaborator

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.

✅ A exemption request has been requested. Please wait for a maintainer's review.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 718c91d
  • Result: FAILED
  • Build Logs (available for 30 days)

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

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 effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-ecs-patterns: add support for pidMode in ApplicationLoadBalancedFargateService
2 participants