source

Documentation

Overview

Package source provides event streams to hook up to Controllers with Controller.Watch. Events are used with handler.EventHandlers to enqueue reconcile.Requests and trigger Reconciles for resources.

The implementation is derived from sigs.k8s.io/controller-runtime/pkg/source and the main difference are: - sources are resourceGroup aware. - the package provide only one sources implementation, Informer.

Index

• type Informer
  • func (is *Informer) Start(_ context.Context, handler chandler.EventHandler, ...) error
  • func (is *Informer) String() string
• type Source

Types

type Informer

type Informer struct {
	Informer ccache.Informer
}

Informer is used to provide a source of events originating from CRUD operations inside the resourceGroup (e.g. Resource Create).

func (*Informer) Start

func (is *Informer) Start(_ context.Context, handler chandler.EventHandler, queue workqueue.RateLimitingInterface, prct ...cpredicate.Predicate) error

Start implements Source.

func (*Informer) String

func (is *Informer) String() string

type Source

type Source interface {
	// Start is internal and should be called only by the Controller to register an EventHandler with the Informer
	// to enqueue reconcile.Requests.
	Start(context.Context, chandler.EventHandler, workqueue.RateLimitingInterface, ...cpredicate.Predicate) error
}

Source is a source of events (e.g. Create, Update, Delete operations on resources) which should be processed by event.EventHandlers to enqueue reconcile.Requests.