controller

Documentation

Overview

Package controller list and keep watching a specific Kubernetes resource kind (ie. "apps/v1 Deployment", "v1 Namespace", etc) and notifies a recorder whenever a change happens (an object changed, was created, or deleted). This is a generic implementation: the resource kind to watch is provided at runtime. We should start several such controllers to watch for distinct resources.

Index

• type Controller
  • func New(client cache.ListerWatcher, notifier event.Notifier, log logger, name string, ...) *Controller
  • func (c *Controller) Start()
  • func (c *Controller) Stop()
• type Factory
  • func NewFactory(logger logger, filter string, resync int, excluded []string) *Factory
  • func (f *Factory) NewController(client cache.ListerWatcher, notifier event.Notifier, name string) Interface
• type Interface

Types

type Controller

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

Controller is a generic kubernetes controller

func New

func New(client cache.ListerWatcher,
	notifier event.Notifier,
	log logger,
	name string,
	filter string,
	resync time.Duration,
	excluded []string,
) *Controller

New return a kubernetes controller using the provided client

func (*Controller) Start

func (c *Controller) Start()

Start launchs the controller in the background

func (*Controller) Stop

func (c *Controller) Stop()

Stop halts the controller

type Factory

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

Factory generate controllers

func NewFactory

func NewFactory(logger logger, filter string, resync int, excluded []string) *Factory

NewFactory create a controller factory

func (*Factory) NewController

func (f *Factory) NewController(client cache.ListerWatcher, notifier event.Notifier, name string) Interface

NewController create a controller.Controller

type Interface

type Interface interface {
	Start()
	Stop()
}

Interface describe a standard kubernetes controller