RestCfg: Add godocs on how to disable ratelimiting

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.

Kubernetes-commit: cd1645ff2c195fbb353cfabcbc36e3c3b883c3c5
This commit is contained in:
Alvaro Aleman 2024-09-27 10:34:15 -04:00 committed by Kubernetes Publisher
parent 5fceb99b61
commit 7416b2ea43

View File

@ -113,6 +113,9 @@ type Config struct {
// QPS indicates the maximum QPS to the master from this client.
// 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
// Maximum burst for throttle.