Skip to content

Commit bae7940

Browse files
dbaumgartenJim Ryan
andcommitted
Apply suggestions from code review
Co-authored-by: Jim Ryan <j.ryan@f5.com> Signed-off-by: dbaumgarten <mail@dbaumgarten.net>
1 parent 8cae670 commit bae7940

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/content/configuration/ingress-resources/advanced-configuration-with-annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ The table below summarizes the available annotations.
187187
|``nginx.org/limit-req-dry-run`` | N/A | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. | false | true |
188188
|``nginx.org/limit-req-log-level`` | N/A | Sets the desired logging level for cases when the server refuses to process requests due to rate exceeding, or delays request processing. Allowed values are info, notice, warn or error. | error | info |
189189
|``nginx.org/limit-req-reject-code`` | N/A | Sets the status code to return in response to rejected requests. Must fall into the range 400..599. | 429 | 503 |
190-
|``nginx.org/limit-req-scale`` | N/A | If set to true, the configured rate is divided by the number of nginx-ingress pods currently serving traffic. This maintains a constant rate-limit, even if the number of nginx-pods changes due to autoscaling. | false | true |
190+
|``nginx.org/limit-req-scale`` | N/A | Enables a constant rate-limit by dividing the configured rate by the number of nginx-ingress pods currently serving traffic. This adjustment ensures that the rate-limit remains consistent, even as the number of nginx-pods fluctuates due to autoscaling. | false | true |
191191
{{% /table %}}
192192

193193
### Snippets and Custom Templates

docs/content/configuration/policy-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ rateLimit:
124124
|``dryRun`` | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. | ``bool`` | No |
125125
|``logLevel`` | Sets the desired logging level for cases when the server refuses to process requests due to rate exceeding, or delays request processing. Allowed values are ``info``, ``notice``, ``warn`` or ``error``. Default is ``error``. | ``string`` | No |
126126
|``rejectCode`` | Sets the status code to return in response to rejected requests. Must fall into the range ``400..599``. Default is ``503``. | ``int`` | No |
127-
|``scale`` | When set to true, the configured ratelimit is divided by the number of currently active ingress-pods. This ensures a consistent ratelimit, even when autoscaling is enabled. | ``bool`` | No |
127+
|``scale`` | Enables a constant rate-limit by dividing the configured rate by the number of nginx-ingress pods currently serving traffic. This adjustment ensures that the rate-limit remains consistent, even as the number of nginx-pods fluctuates due to autoscaling. | ``bool`` | No |
128128
{{% /table %}}
129129

130130
> For each policy referenced in a VirtualServer and/or its VirtualServerRoutes, NGINX Ingress Controller will generate a single rate limiting zone defined by the [`limit_req_zone`](http://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone) directive. If two VirtualServer resources reference the same policy, NGINX Ingress Controller will generate two different rate limiting zones, one zone per VirtualServer.

0 commit comments

Comments
 (0)