Ingress-nginx: Units of nginx.ingress.kubernetes.io/limit-rate and nginx.ingress.kubernetes.io/limit-rate-after

Created on 10 Nov 2018 · 7Comments · Source: kubernetes/ingress-nginx

The documentation for the nginx.ingress.kubernetes.io/limit-rate and nginx.ingress.kubernetes.io/limit-rate-after annotations states:

The annotation nginx.ingress.kubernetes.io/limit-rate, nginx.ingress.kubernetes.io/limit-rate-after define a limit the rate of response transmission to a client. The rate is specified in bytes per second. The zero value disables rate limiting.

First, the wording is poor/confusing.

Second, it states: "The rate is specified in bytes per second."
However, the template adds a k suffix to the limit_rate and limit_rate_after statements, meaning they are actually in kilobytes per second and kilobytes, respectively.

More generally, I expected these annotations to behave the same as limit_rate and limit_rate_after in NGINX: they are actually specified in bytes (per second) and either accept a bare number (e.g., 100 -> 100 bytes per second) or allow a suffix (e.g., 5k -> 5 kilobytes per second). I realize that's a breaking change, but it is a lot more intuitive.

If you're not willing to make that change, the documentation still needs to be corrected.

kindocumentation lifecyclrotten

Source

averigin

👍1

Most helpful comment

@averigin pull requests are always welcome

aledbf on 11 Nov 2018

👍2

All 7 comments

@averigin pull requests are always welcome

aledbf on 11 Nov 2018

👍2

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

fejta-bot on 9 Feb 2019

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

fejta-bot on 11 Mar 2019

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

fejta-bot on 10 Apr 2019

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.