controller

Documentation

Overview

Kubernetes controller boilerplate.

Index

• func AddHandler(informer cache.SharedIndexInformer, kind string) workqueue.RateLimitingInterface
• func NewEventHandler(kind string, queue workqueue.Interface) cache.ResourceEventHandler
• type Controller
  • func NewController(gvk schema.GroupVersionKind, informer cache.SharedIndexInformer, ...) *Controller
  • func (c *Controller) GetQueue() workqueue.Interface
  • func (c *Controller) Run()
• type Handler

Functions

func AddHandler

func AddHandler(informer cache.SharedIndexInformer, kind string) workqueue.RateLimitingInterface

AddHandler creates and adds an event handler to the informer. It returns the queue associated to the event handler.

func NewEventHandler

func NewEventHandler(kind string, queue workqueue.Interface) cache.ResourceEventHandler

NewEventHandler creates an event handler which just adds events to the given queue.

Types

type Controller

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

Controller describes a controller to watch the given GVK events.

func NewController

func NewController(gvk schema.GroupVersionKind, informer cache.SharedIndexInformer, handler Handler) *Controller

NewController creates a controller.

func (*Controller) GetQueue

func (c *Controller) GetQueue() workqueue.Interface

GetQueue returns the event queue used by the controller. It can be useful to inject extra events for the controller. See pkg/converter/endpoints/controller.go for an example.

func (*Controller) Run

func (c *Controller) Run()

Run executes the controller.

type Handler

type Handler interface {
	Update(string, schema.GroupVersionKind, interface{}) error
	Delete(string) error
}

Handler is a set of callbacks to process events on the queue.