options

Documentation

Overview

Package options provides functional options for controller runtime.

Index

• type Option
  • func WithChangeRateLimit(limit rate.Limit, burst int) Option
  • func WithMetrics(enabled bool) Option
• type Options
  • func DefaultOptions() Options

Types

type Option

type Option func(*Options)

Option is a functional option for controller runtime.

func WithChangeRateLimit

func WithChangeRateLimit(limit rate.Limit, burst int) Option

WithChangeRateLimit sets rate limit for changes performed by controllers.

This might be used to rate limit ill-behaving controllers from overloading the system with changes.

func WithMetrics

func WithMetrics(enabled bool) Option

WithMetrics enables runtime metrics to be exposed via metrics package.

type Options

type Options struct {
	// ChangeRateLimit and ChangeBurst configure rate limiting of changes performed by controllers.
	ChangeRateLimit rate.Limit
	ChangeBurst     int
	MetricsEnabled  bool
}

Options configures controller runtime.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns default value of Options.