-
Notifications
You must be signed in to change notification settings - Fork 8.5k
Config/Annotations: Fix proxy-busy-buffers-size.
#13610
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
Config/Annotations: Fix proxy-busy-buffers-size.
#13610
Conversation
|
This issue is currently awaiting triage. If Ingress contributors determines this is a relevant issue, they will accept it by applying the The 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. |
|
Hi @pando85. 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 Once the patch is verified, the new status will be reflected by the 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-sigs/prow repository. |
✅ Deploy Preview for kubernetes-ingress-nginx ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
995f3d9 to
45ef3b8
Compare
|
Thank you for submitting this fix. Let me take a look /ok-to-test |
|
/assign |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Restores backward compatibility by only rendering the proxy_busy_buffers_size directive when the corresponding annotation is explicitly set, updates parser logic to avoid defaulting when the annotation is absent, and adjusts unit tests accordingly.
- Wrap the
proxy_busy_buffers_sizedirective in the nginx template behind a presence check. - Change annotation parsing to clear
BusyBuffersSizeinstead of defaulting when missing. - Update existing test to expect an empty value and add a test for when the annotation is present.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| rootfs/etc/nginx/template/nginx.tmpl | Conditionally render proxy_busy_buffers_size only if annotation is set |
| internal/ingress/annotations/proxy/main.go | Remove default fallback for BusyBuffersSize and clear it when missing |
| internal/ingress/annotations/proxy/main_test.go | Update tests for absence; add test for presence of BusyBuffersSize |
Comments suppressed due to low confidence (4)
internal/ingress/annotations/proxy/main.go:306
- Differentiate between a missing annotation and a parse error: only swallow the ‘annotation not found’ case and propagate or log other errors to avoid silently dropping invalid values.
if err != nil {
internal/ingress/annotations/proxy/main_test.go:310
- Include the actual error in the failure message (e.g.,
t.Fatalf("unexpected error: %v", err)) to aid debugging when the test fails.
t.Fatalf("unexpected error parsing a valid")
internal/ingress/annotations/proxy/main_test.go:302
- Consider adding a test for an invalid or malformed
proxy-busy-buffers-sizevalue to verify that parse errors are handled as expected.
// Add a test for when annotation is set
rootfs/etc/nginx/template/nginx.tmpl:1079
- [nitpick] Adjust indentation of the
if/endblock to align with surrounding directives for consistent readability in the template.
{{ if $location.Proxy.BusyBuffersSize }}
|
Adding this link for others to reference |
http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_busy_buffers_size We can leave it blank by default when the user does not set the annotation, so that Nginx will use the default value |
tao12345666333
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for submitting this fix, it looks great and will fix the issue
|
I am already working on this, @tao12345666333. Wanted to get it merged today. |
|
If you have any other comments, I will be happy to address them. |
|
Not yet, but I wanted to do some maintenance work, like bumping Go, Kubernetes and stuff and deprecating v1.11, first before merging user provided PRs after the release. |
proxy-busy-buffers-size backward compatibilityproxy-busy-buffers-size.
ea7fa26 to
4cb49bc
Compare
|
/cherry-pick release-1.13 |
|
@Gacko: once the present PR merges, I will cherry-pick it on top of In response to this:
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. |
4cb49bc to
30718c2
Compare
Gacko
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/unhold
/lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Gacko, pando85 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@Gacko: new pull request created: #13638 In response to this:
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. |
|
any ETA for the patch release? |
|
Still waiting on what to expect for a patch release. |
|
I don't wanna disappoint you, but rather kindly remind you we're all doing this in our free time. To me this sounds close to demanding, but nevertheless, I managed to kick off the release process besides my day to day job. 🙂 |
Perhaps it was a bit demanding. From my perspective, it had been weeks since the fix had been merged and the comments from the team suggested that it would be a quick process. I have been waiting weeks to get ingress-nginx sorted because there was another issue that kept me from upgrading that you all decided to just not fix. So once I sorted that out on my end I upgraded only to find that the pods wont start. I completely understand that you are doing this in your free time. I wasn't asking for anything other then an expectation to be set. Not to be too greedy or demanding but I still don't know what to expect for when that fix might be available. |
proxy-busy-buffers-sizeannotation.proxy_busy_buffers_sizedirective is only rendered in the nginx template if the annotation is explicitly set.What this PR does / why we need it:
#13598
Types of changes
Which issue/s this PR fixes
How Has This Been Tested?
Checklist: