github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 01:06:27 +00:00
Code Issues Projects Releases Wiki Activity

RestCfg: Add godocs on how to disable ratelimiting

Browse Source 
I frequently find myself in the situation of not remembering which of
QPS/Burst I have to set. This change adds a small go doc to clarify
that.
This commit is contained in:
Alvaro Aleman 2024-09-27 10:34:15 -04:00
parent 3d6c5b2e98
commit cd1645ff2c
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
staging/src/k8s.io/client-go/rest/config.go
View File

@ -113,6 +113,9 @@ type Config struct {
// QPS indicates the maximum QPS to the master from this client. // QPS indicates the maximum QPS to the master from this client.
// If it's zero, the created RESTClient will use DefaultQPS: 5 // If it's zero, the created RESTClient will use DefaultQPS: 5
//
// Setting this to a negative value will disable client-side ratelimiting
// unless `Ratelimiter` is also set.
QPS float32 QPS float32
// Maximum burst for throttle. // Maximum burst for throttle.