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): unclear docs on valid ec2 task definition placement constraints and no validation of input #25933 #26384

Merged
merged 26 commits into from
Aug 2, 2023

Conversation

Adibuer-lab
Copy link
Contributor

@Adibuer-lab Adibuer-lab commented Jul 17, 2023

Docs were unclear on valid placement constraints. You can specify distinctInstances when creating a Service, or running a task. You can specify memberOf when doing the previous two actions, or when creating a task or new revision. So far only memberOf is valid for ec2 task definitions.

This pull request enhances the documentation and validation for task definition placement constraints in the aws-cdk-lib/aws-ecs package. The documentation now includes a note clarifying the valid placement constraints and a new validatePlacementConstraints method has been added to the Ec2TaskDefinition class to validate the constraints at synth time.

The changes include:

Enhancement of documentation in ec2-task-definition.ts to include a note about valid placement constraints.
Addition of the validatePlacementConstraints method in ec2-task-definition.ts to validate placement constraints at synth time.
Addition of unit tests in ec2-task-definition.test.ts to verify the correct behavior of the new validatePlacementConstraints method.
Addition of integration tests to ensure overall functionality.
Closes #25905.

Revival of #25933


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

Adibuer-lab and others added 20 commits June 11, 2023 21:57
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>
@aws-cdk-automation aws-cdk-automation requested a review from a team July 17, 2023 00:28
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Jul 17, 2023
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.

@Adibuer-lab Adibuer-lab changed the title Fix/25905 ecs placement constraints fix(ecs): unclear docs on valid ec2 task definition placement constraints and no validation of input #25933 Jul 17, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review July 17, 2023 00:32

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

@Adibuer-lab Adibuer-lab marked this pull request as ready for review July 17, 2023 00:32
@Adibuer-lab
Copy link
Contributor Author

@kaizencc made requested changes

@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 Jul 17, 2023
@mrgrain
Copy link
Contributor

mrgrain commented Jul 17, 2023

Hi and thanks for your contribution! We can only accept contributions that comply with our license requirements.
Please include the following statement in you PR description.

----

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

@Adibuer-lab
Copy link
Contributor Author

Hi and thanks for your contribution! We can only accept contributions that comply with our license requirements. Please include the following statement in you PR description.

----

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

Done :)

Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

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

Hi @Adibuer-lab! Thanks for reviving this PR! Just one comment about the valid constraints, did one just get added?

@mergify mergify bot dismissed kaizencc’s stale review August 1, 2023 16:01

Pull request has been modified.

Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

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

Thanks @Adibuer-lab

@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 Aug 2, 2023
@mergify
Copy link
Contributor

mergify bot commented Aug 2, 2023

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: f480d7b
  • 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 4c57f45 into aws:main Aug 2, 2023
8 checks passed
@mergify
Copy link
Contributor

mergify bot commented Aug 2, 2023

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

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: TaskDefinition constraint.type 'distinctInstance' is not supported
4 participants