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

chore(eks): add warning to make kubectlLayer property required in the future #32483

Merged
merged 4 commits into from
Dec 17, 2024

Conversation

xazhao
Copy link
Contributor

@xazhao xazhao commented Dec 11, 2024

Reason for this change

kubectlLayer property in EKS Cluster is currently optional. If not provided, it will use a very outdated version (1.20). This default outdated version adds a outdated dependency to CDK which should be removed.

However, we can't simply update the version because it will be a breaking change. To avoid this issue happening again, we can send a warning first then we can do a one-time breaking change to make the property required.

Another reason is the synth error (users have to provide the property) is better than we upgrading the version silently which may lead to some unexpected behavior.

Description of changes

Update warning to let customers know this property will become required in 2025 Jan.

Description of how you validated changes

Checklist


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

@xazhao xazhao marked this pull request as ready for review December 11, 2024 17:37
@aws-cdk-automation aws-cdk-automation requested a review from a team December 11, 2024 17:37
@github-actions github-actions bot added the p2 label Dec 11, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 11, 2024
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.

@xazhao i'm curious why you've decided on this path over a feature flag?

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.80%. Comparing base (93ff387) to head (3794711).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32483   +/-   ##
=======================================
  Coverage   78.80%   78.80%           
=======================================
  Files         108      108           
  Lines        7159     7159           
  Branches     1319     1319           
=======================================
  Hits         5642     5642           
  Misses       1332     1332           
  Partials      185      185           
Flag Coverage Δ
suite.unit 78.80% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 78.80% <ø> (ø)

@xazhao
Copy link
Contributor Author

xazhao commented Dec 11, 2024

@xazhao i'm curious why you've decided on this path over a feature flag?

The issue is the default version bundled an outdated dependency in CDK ("@aws-cdk/asset-kubectl-v20": "^2.1.3").

This dependency uses helm version 3.8.1 which is related to this CVE https://security.snyk.io/vuln/SNYK-CHAINGUARDLATEST-HELM-7219926

Using a feature flag will still keep the dependency.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 11, 2024
Copy link
Contributor

mergify bot commented Dec 12, 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).

Copy link
Contributor

mergify bot commented Dec 12, 2024

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated.

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 12, 2024
Copy link
Contributor

mergify bot commented Dec 12, 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).

@GavinZZ
Copy link
Contributor

GavinZZ commented Dec 16, 2024

@mergify update

Copy link
Contributor

mergify bot commented Dec 16, 2024

update

❌ Mergify doesn't have permission to update

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/request-cli-integ-test.yml without workflows permission

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Dec 17, 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 5e01cc2 into aws:main Dec 17, 2024
17 checks passed
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants