options

Documentation

Overview

Package options provides functional options for controller runtime.

Index

• type CachedResource
• type Option
  • func WithCachedResource(namespace resource.Namespace, typ resource.Type) Option
  • func WithChangeRateLimit(limit rate.Limit, burst int) Option
  • func WithMetrics(enabled bool) Option
  • func WithWarnOnUncachedReads(warn bool) Option
• type Options
  • func DefaultOptions() Options

Types

type CachedResource

type CachedResource struct {
	Namespace resource.Namespace
	Type      resource.Type
}

CachedResource is a resource that should be cached by controller runtime.

type Option

type Option func(*Options)

Option is a functional option for controller runtime.

func WithCachedResource

func WithCachedResource(namespace resource.Namespace, typ resource.Type) Option

WithCachedResource adds a resource to the list of resources that should be cached by 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.

func WithWarnOnUncachedReads

func WithWarnOnUncachedReads(warn bool) Option

WithWarnOnUncachedReads adds a warning log when a controller reads an uncached resource.

type Options

type Options struct {
	// CachedResources is a list of resources that should be cached by controller runtime.
	CachedResources []CachedResource
	// ChangeRateLimit and ChangeBurst configure rate limiting of changes performed by controllers.
	ChangeRateLimit rate.Limit
	ChangeBurst     int
	// MetricsEnabled enables runtime metrics to be exposed via metrics package.
	MetricsEnabled bool
	// WarnOnUncachedReads adds a warning log when a controller reads an uncached resource.
	WarnOnUncachedReads bool
}

Options configures controller runtime.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns default value of Options.