runtime

Documentation

Overview

Package runtime implements the controller runtime.

Index

• type Option
  • func WithChangeRateLimit(limit rate.Limit, burst int) Option
  • func WithMetrics(enabled bool) Option
• type Options
  • func DefaultOptions() Options
• type Runtime
  • func NewRuntime(st state.State, logger *zap.Logger, opt ...Option) (*Runtime, error)
  • func (runtime *Runtime) GetDependencyGraph() (*controller.DependencyGraph, error)
  • func (runtime *Runtime) RegisterController(ctrl controller.Controller) error
  • func (runtime *Runtime) Run(ctx context.Context) error

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.

type Runtime

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

Runtime implements controller runtime.

func NewRuntime

func NewRuntime(st state.State, logger *zap.Logger, opt ...Option) (*Runtime, error)

NewRuntime initializes controller runtime object.

func (*Runtime) GetDependencyGraph

func (runtime *Runtime) GetDependencyGraph() (*controller.DependencyGraph, error)

GetDependencyGraph returns dependency graph between resources and controllers.

func (*Runtime) RegisterController

func (runtime *Runtime) RegisterController(ctrl controller.Controller) error

RegisterController registers new controller.

func (*Runtime) Run

func (runtime *Runtime) Run(ctx context.Context) error

Run all the controller loops.