This is an automated email from the ASF dual-hosted git repository.
yzheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 07d738ac1 Update doc for helm around rateLimiter (#3562)
07d738ac1 is described below
commit 07d738ac19786096685d5758e1b529566bb55b17
Author: Yong Zheng <[email protected]>
AuthorDate: Tue Jan 27 02:00:56 2026 -0600
Update doc for helm around rateLimiter (#3562)
---
helm/polaris/README.md | 6 +++---
site/content/in-dev/unreleased/helm.md | 6 +++---
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/helm/polaris/README.md b/helm/polaris/README.md
index 738db39d3..c9bf272d8 100644
--- a/helm/polaris/README.md
+++ b/helm/polaris/README.md
@@ -412,9 +412,9 @@ ct install --namespace polaris --charts ./helm/polaris
| podSecurityContext | object |
`{"fsGroup":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | Security
context for the polaris pod. See
https://kubernetes.io/docs/tasks/configure-pod-container/security-context/. |
| podSecurityContext.fsGroup | int | `10001` | GID 10001 is compatible with
Polaris OSS default images; change this if you are using a different image. |
| priorityClassName | string | `nil` | Priority class name for polaris pods.
See
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#pod-priority
|
-| rateLimiter | object |
`{"tokenBucket":{"requestsPerSecond":9999,"type":"default","window":"PT10S"},"type":"no-op"}`
| Polaris rate limiter configuration. |
-| rateLimiter.tokenBucket | object |
`{"requestsPerSecond":9999,"type":"default","window":"PT10S"}` | The
configuration for the default rate limiter, which uses the token bucket
algorithm with one bucket per realm. |
-| rateLimiter.tokenBucket.requestsPerSecond | int | `9999` | The maximum
number of requests per second allowed for each realm. |
+| rateLimiter | object |
`{"tokenBucket":{"requestsPerSecond":9999,"type":"default"},"type":"no-op"}` |
Polaris rate limiter configuration. |
+| rateLimiter.tokenBucket | object |
`{"requestsPerSecond":9999,"type":"default"}` | The configuration for the
default rate limiter, which uses the token bucket algorithm with one bucket per
realm. |
+| rateLimiter.tokenBucket.requestsPerSecond | int | `9999` | The maximum
number of requests (permits) per second allowed for each realm. |
| rateLimiter.tokenBucket.type | string | `"default"` | The type of the token
bucket rate limiter. Only the default type is supported out of the box. |
| rateLimiter.type | string | `"no-op"` | The type of rate limiter filter to
use. Two built-in types are supported: default and no-op. |
| readinessProbe | object |
`{"failureThreshold":3,"initialDelaySeconds":5,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":10}`
| Configures the readiness probe for polaris pods. |
diff --git a/site/content/in-dev/unreleased/helm.md
b/site/content/in-dev/unreleased/helm.md
index e7b03eb61..e3ef87461 100644
--- a/site/content/in-dev/unreleased/helm.md
+++ b/site/content/in-dev/unreleased/helm.md
@@ -399,9 +399,9 @@ ct install --namespace polaris --charts ./helm/polaris
| podSecurityContext | object |
`{"fsGroup":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | Security
context for the polaris pod. See
https://kubernetes.io/docs/tasks/configure-pod-container/security-context/. |
| podSecurityContext.fsGroup | int | `10001` | GID 10001 is compatible with
Polaris OSS default images; change this if you are using a different image. |
| priorityClassName | string | `nil` | Priority class name for polaris pods.
See
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#pod-priority
|
-| rateLimiter | object |
`{"tokenBucket":{"requestsPerSecond":9999,"type":"default","window":"PT10S"},"type":"no-op"}`
| Polaris rate limiter configuration. |
-| rateLimiter.tokenBucket | object |
`{"requestsPerSecond":9999,"type":"default","window":"PT10S"}` | The
configuration for the default rate limiter, which uses the token bucket
algorithm with one bucket per realm. |
-| rateLimiter.tokenBucket.requestsPerSecond | int | `9999` | The maximum
number of requests per second allowed for each realm. |
+| rateLimiter | object |
`{"tokenBucket":{"requestsPerSecond":9999,"type":"default"},"type":"no-op"}` |
Polaris rate limiter configuration. |
+| rateLimiter.tokenBucket | object |
`{"requestsPerSecond":9999,"type":"default"}` | The configuration for the
default rate limiter, which uses the token bucket algorithm with one bucket per
realm. |
+| rateLimiter.tokenBucket.requestsPerSecond | int | `9999` | The maximum
number of requests (permits) per second allowed for each realm. |
| rateLimiter.tokenBucket.type | string | `"default"` | The type of the token
bucket rate limiter. Only the default type is supported out of the box. |
| rateLimiter.type | string | `"no-op"` | The type of rate limiter filter to
use. Two built-in types are supported: default and no-op. |
| readinessProbe | object |
`{"failureThreshold":3,"initialDelaySeconds":5,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":10}`
| Configures the readiness probe for polaris pods. |
