Add option to disable workqueue bucket rate limiter (#4451)
This commit is contained in:
@@ -1,8 +1,10 @@
|
||||
package actionsgithubcom
|
||||
|
||||
import (
|
||||
"k8s.io/client-go/util/workqueue"
|
||||
"sigs.k8s.io/controller-runtime/pkg/builder"
|
||||
"sigs.k8s.io/controller-runtime/pkg/controller"
|
||||
"sigs.k8s.io/controller-runtime/pkg/reconcile"
|
||||
)
|
||||
|
||||
// Options is the optional configuration for the controllers, which can be
|
||||
@@ -37,6 +39,25 @@ func WithMaxConcurrentReconciles(n int) Option {
|
||||
}
|
||||
}
|
||||
|
||||
// WithTypedRateLimiter sets the rate limiter for the controller's workqueue.
|
||||
//
|
||||
// By default, the controller-runtime uses
|
||||
// workqueue.DefaultTypedControllerRateLimiter[reconcile.Request], which combines
|
||||
// an exponential backoff per-item limiter with a token bucket overall limiter
|
||||
// (10 QPS, 100 bucket size). In large-scale environments with many runner
|
||||
// scale sets, the token bucket limiter can become a bottleneck for
|
||||
// reconciliation throughput.
|
||||
//
|
||||
// Use this option to override the default rate limiter, for example, to use
|
||||
// workqueue.DefaultTypedItemBasedRateLimiter[reconcile.Request], which removes
|
||||
// the overall token bucket constraint while keeping the per-item exponential
|
||||
// backoff.
|
||||
func WithTypedRateLimiter(rateLimiter workqueue.TypedRateLimiter[reconcile.Request]) Option {
|
||||
return func(b *controller.Options) {
|
||||
b.RateLimiter = rateLimiter
|
||||
}
|
||||
}
|
||||
|
||||
// builderWithOptions applies the given options to the provided builder, if any.
|
||||
// This is a helper function to avoid the need to import the controller-runtime package in every reconciler source file
|
||||
// and the command package that creates the controller.
|
||||
|
||||
Reference in New Issue
Block a user