controllerinit

Documentation

Index

• type Informer
• type Runner
• type RunnerBuilder
  • func Prepare(controllers Runner, controllersWrapper RunnerWrapper, informers ...Informer) RunnerBuilder
• type RunnerWrapper

Types

type Informer

type Informer interface {
	Start(stopCh <-chan struct{})
	WaitForCacheSync(stopCh <-chan struct{}) map[reflect.Type]bool
}

Informer is the subset of SharedInformerFactory needed for starting an informer cache and waiting for it to sync.

type Runner

type Runner func(context.Context)

Runner is something that can be run such as a series of controllers. Blocks until context is canceled.

type RunnerBuilder

type RunnerBuilder func(context.Context) (Runner, error)

RunnerBuilder is a function that can be used to construct a Runner. It is expected to be called in the main go routine since the construction can fail.

func Prepare

func Prepare(controllers Runner, controllersWrapper RunnerWrapper, informers ...Informer) RunnerBuilder

Prepare returns RunnerBuilder that, when called: 1.) Starts all provided informers and waits for them sync (and fails if they hang), and 2.) Returns a Runner that combines the Runner and RunnerWrapper passed into Prepare.

type RunnerWrapper

type RunnerWrapper func(context.Context, Runner)

RunnerWrapper takes a Runner and wraps its execution with other logic. Blocks until context is canceled. RunnerWrapper is responsible for the lifetime of the passed in Runner.