ratelimiter

Documentation

Index

• type RateLimiter
  • func NewRateLimiter(c client.Client, log logr.Logger, maxItems int, ...) *RateLimiter
  • func (r *RateLimiter) SetupWithManager(mgr ctrl.Manager) error
  • func (r *RateLimiter) ShouldReconcile(nsName types.NamespacedName) bool
  • func (r *RateLimiter) Start(ctx context.Context) error

Types

type RateLimiter

type RateLimiter struct {
	// contains filtered or unexported fields
}

RateLimiter is a rate limiter for controllers.

func NewRateLimiter

func NewRateLimiter(
	c client.Client,
	log logr.Logger,
	maxItems int,
	itemIsReady func(context.Context, client.Client, types.NamespacedName, logr.Logger) bool,
	durationToBecomeReady time.Duration,
	logFrequency time.Duration,
	itemPoolingInterval time.Duration,
	itemTimeout time.Duration,
) *RateLimiter

NewRateLimiter creates a new RateLimiter.

func (*RateLimiter) SetupWithManager

func (r *RateLimiter) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager instantiate the RateLimiter, managed by a given manager.

func (*RateLimiter) ShouldReconcile

func (r *RateLimiter) ShouldReconcile(nsName types.NamespacedName) bool

ShouldReconcile check the given item. if the item is ready for reconciliation, ShouldReconcile removes the item from buffer and returns true.

func (*RateLimiter) Start

func (r *RateLimiter) Start(ctx context.Context) error

Start will start the RateLimiter.