ingress-nginx
ingress-nginx copied to clipboard
kubernetes
fix: Ensure changes in MatchCN annotation are detected
What this PR does / why we need it:
Ensure the AuthTLS config correctly detects changes in MatchCN.
Types of changes
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] CVE Report (Scanner found CVE and adding report)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation only
Which issue/s this PR fixes
Fixes #10915
How Has This Been Tested?
I have built the docker image and deployed it into our kubernetes cluster that was exhibiting the bug.
When this version is running the nginx.conf file is correctly updated when the nginx.ingress.kubernetes.io/auth-tls-match-cn is updated.
I could not immediately find an end-to-end test that covers this scenario, but if you point me in the right direction, I'll happily add one.
Checklist:
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [x] I've read the CONTRIBUTION guide
- [x] I have added unit and/or e2e tests to cover my changes.
- [x] All new and existing tests passed.
This issue is currently awaiting triage.
If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.
The triage/accepted label can be added by org members by writing /triage accepted in a comment.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
Welcome @wdullaer!
It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.
You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.
You can also check if kubernetes/ingress-nginx has its own contribution guidelines.
You may want to refer to our testing guide if you run into trouble with your tests not passing.
If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!
Thank you, and welcome to Kubernetes. :smiley:
Hi @wdullaer. Thanks for your PR.
I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
Deploy Preview for kubernetes-ingress-nginx ready!
| Name | Link |
|---|---|
| Latest commit | 4c2490562a6353e931e68588021894a811b270df |
| Latest deploy log | https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/66150ffd41cd7b0008180693 |
| Deploy Preview | https://deploy-preview-11173--kubernetes-ingress-nginx.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
The e2e test for this looks to be here.
https://github.com/kubernetes/ingress-nginx/blob/main/test/e2e/annotations/authtls.go#L267
None of the reload behaviour seems to be tested there right now. Shall I try to add one test?
Edit: added an e2e test which exercises the reload behaviour of this annotation.
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by: wdullaer Once this PR has been reviewed and has the lgtm label, please assign rikatz for approval. For more information see the Kubernetes Code Review Process.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
~~The linting issues are in files I didn't touch. Am I expected to fix these?~~ Edit: nothing a rebase of main can't fix.
This is stale, but we won't close it automatically, just bare in mind the maintainers may be busy with other tasks and will reach your issue ASAP. If you have any question or request to prioritize this, please reach #ingress-nginx-dev on Kubernetes Slack.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
The lifecycle/frozen label can not be applied to PRs.
This bot removes lifecycle/frozen from PRs because:
- Commenting
/lifecycle frozenon a PR has not worked since March 2021 - PRs that remain open for >150 days are unlikely to be easily rebased
You can:
- Rebase this PR and attempt to get it merged
- Close this PR with
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/remove-lifecycle frozen
This PR is still valid:
- The issue is still present
- The fix still works
- Tests are passing
- Nothing needs to be rebased
From my point of view, there is no work left to be done. I'm waiting for maintainer feedback/review.
@puerco @cpanato Do you have an indication for when this change can be reviewed?
We're still suffering from this bug in production, and I don't really look forward to maintaining a custom version of the ingress long term.
The code change itself is very small, it shouldn't take too long.
@strongjz: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.
In response to this:
/lgtm
/cherry-pick release-1.10
/cherry-pick release-1.11
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: strongjz, wdullaer
The full list of commands accepted by this bot can be found here.
The pull request process is described here
- ~~OWNERS~~ [strongjz]
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
@strongjz: new pull request created: #11528
In response to this:
/lgtm
/cherry-pick release-1.10
/cherry-pick release-1.11
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
@strongjz: new pull request created: #11529
In response to this:
/lgtm
/cherry-pick release-1.10
/cherry-pick release-1.11
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.