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(eks): helm uninstall in custom resource handler does not respect Wait #28830

Merged
merged 2 commits into from
Jan 25, 2024

Conversation

ellistarn
Copy link
Contributor

@ellistarn ellistarn commented Jan 23, 2024

I have a stack that installs and uninstalls helm charts, where the underlying resources use Kubernetes Finalizers. CDK's helm construct currently ignores --wait, which means that any object finalization in those helm charts is not respected in my dependency ordering.

Compatibility

I could see some debate around whether or not this is a breaking change. I'm currently viewing it as a bug fix. I'm a bit cautious about how valuable it would be to gate this behavior compared to the additional complexity.

Testing

Tested on a local fork and it worked like a charm

Closes #28831


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

I have a stack that installs and uninstalls helm charts, where the underlying resources use [Kubernetes Finalizers](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/). CDK currently ignores `--wait`, which means that any object finalization in not respected in my dependency ordering.
@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Jan 23, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 23, 2024 20:24
@ellistarn ellistarn changed the title [aws-eks] fix: Helm custom handler now respects --wait fix(eks): Helm custom handler now respects --wait Jan 23, 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 the bug This issue is a bug. label Jan 23, 2024
@ellistarn
Copy link
Contributor Author

Exemption Request: #28830 (review). This code does not have testing built out yet AFAICT.

@aws-cdk-automation aws-cdk-automation added pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jan 23, 2024
@mrgrain mrgrain changed the title fix(eks): Helm custom handler now respects --wait fix(eks): helm uninstall in custom resource handler does not respect Wait Jan 24, 2024
Copy link
Contributor

@GavinZZ GavinZZ left a comment

Choose a reason for hiding this comment

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

I would classify this issue as a bug and accept the minor breaking changes, so going to approve this PR.

My reasoning for the approval is that prior to this proposed modification, setting wait=True resulted in identical behavior to wait=False or not set at all. Consequently, this update is reasonable. However, it will alter the existing behavior for users who have previously set wait=True, as they will now experience a delay while waiting for the uninstallation process to complete. The change is confined to CLI change and its primary impact is merely extending the duration users will need to wait for the command’s execution to finish.

@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 Jan 24, 2024
@ellistarn
Copy link
Contributor Author

Anything I need to do to dismiss the testing linter errors?

@GavinZZ GavinZZ added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels Jan 25, 2024
@aws-cdk-automation aws-cdk-automation dismissed stale reviews from themself January 25, 2024 18:27

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

Copy link
Contributor

mergify bot commented Jan 25, 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: d7ab96e
  • 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 7a30f5d into aws:main Jan 25, 2024
10 checks passed
Copy link
Contributor

mergify bot commented Jan 25, 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).

@ellistarn ellistarn deleted the patch-1 branch January 25, 2024 21:04
Vandita2020 pushed a commit to Vandita2020/aws-cdk that referenced this pull request Jan 30, 2024
…`Wait` (aws#28830)

I have a stack that installs and uninstalls helm charts, where the underlying resources use [Kubernetes Finalizers](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/). CDK's helm construct currently ignores `--wait`, which means that any object finalization in those helm charts is not respected in my dependency ordering.

## Compatibility

I could see some debate around whether or not this is a breaking change. I'm currently viewing it as a bug fix. I'm a bit cautious about how valuable it would be to gate this behavior compared to the additional complexity.

## Testing

Tested on a local fork and it worked like a charm

Closes aws#28831

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
SankyRed pushed a commit that referenced this pull request Feb 8, 2024
…`Wait` (#28830)

I have a stack that installs and uninstalls helm charts, where the underlying resources use [Kubernetes Finalizers](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/). CDK's helm construct currently ignores `--wait`, which means that any object finalization in those helm charts is not respected in my dependency ordering.

## Compatibility

I could see some debate around whether or not this is a breaking change. I'm currently viewing it as a bug fix. I'm a bit cautious about how valuable it would be to gate this behavior compared to the additional complexity.

## Testing

Tested on a local fork and it worked like a charm

Closes #28831

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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. p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-test The PR linter will not require test changes 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.

(eks): Helm custom handler uninstall does not respect --wait
3 participants