reconciler

Documentation

Overview

Package reconciler defines implementations of the Reconciler interface defined at github.com/knative/pkg/controller.Reconciler. These implement the basic workhorse functionality of controllers, while leaving the shared controller implementation to manage things like the workqueue.

Despite defining a Reconciler, each of the packages here are expected to expose a controller constructor like:

func NewController(...) *controller.Impl { ... }

These constructors will:

1. Construct the Reconciler,
2. Construct a controller.Impl with that Reconciler,
3. Wire the assorted informers this Reconciler watches to call appropriate enqueue methods on the controller.

Index

• Constants
• func AnnotationFilterFunc(key string, value string, allowUnset bool) func(interface{}) bool
• func GetK8sServiceFullname(name string, namespace string) string
• func GetServingK8SServiceNameForObj(name string) string
• func GetServingRevisionNameForK8sService(name string) string
• func Handler(h func(interface{})) cache.ResourceEventHandler
• func LabelExistsFilterFunc(label string) func(obj interface{}) bool
• func MustNewStatsReporter(reconciler string, logger *zap.SugaredLogger) controller.StatsReporter
• type Base
  • func NewBase(opt Options, controllerAgentName string) *Base
• type Measurement
• type Options
  • func NewOptionsOrDie(cfg *rest.Config, logger *zap.SugaredLogger, stopCh <-chan struct{}) Options
  • func (o Options) GetTrackerLease() time.Duration
• type StatsReporter
  • func NewStatsReporter(reconciler string) (StatsReporter, error)

Constants

const (
	// ServiceReadyCountN is the number of services that have become ready.
	ServiceReadyCountN = "service_ready_count"
	// ServiceReadyLatencyN is the time it takes for a service to become ready since the resource is created.
	ServiceReadyLatencyN = "service_ready_latency"
)

Functions

func AnnotationFilterFunc

func AnnotationFilterFunc(key string, value string, allowUnset bool) func(interface{}) bool

AnnotationFilterFunc creates a FilterFunc only accepting objects with given annotation key and value

func GetK8sServiceFullname

func GetK8sServiceFullname(name string, namespace string) string

GetK8sServiceFullname returns service full name

func GetServingK8SServiceNameForObj

func GetServingK8SServiceNameForObj(name string) string

GetServingK8SServiceNameForObj returns the service name for the object

func GetServingRevisionNameForK8sService

func GetServingRevisionNameForK8sService(name string) string

GetServingRevisionNameForK8sService returns the revision name from the service name

func Handler

func Handler(h func(interface{})) cache.ResourceEventHandler

Handler wraps the provided handler function into a cache.ResourceEventHandler that sends all events to the given handler. For Updates, only the new object is forwarded.

func LabelExistsFilterFunc

func LabelExistsFilterFunc(label string) func(obj interface{}) bool

LabelExistsFilterFunc creates a FilterFunc only accepting objects which have a given label.

func MustNewStatsReporter

func MustNewStatsReporter(reconciler string, logger *zap.SugaredLogger) controller.StatsReporter

MustNewStatsReporter creates a new instance of StatsReporter. Panics if creation fails.

Types

type Base

type Base struct {
	// KubeClientSet allows us to talk to the k8s for core APIs
	KubeClientSet kubernetes.Interface

	// SharedClientSet allows us to configure shared objects
	SharedClientSet sharedclientset.Interface

	// ServingClientSet allows us to configure Serving objects
	ServingClientSet clientset.Interface

	// DynamicClientSet allows us to configure pluggable Build objects
	DynamicClientSet dynamic.Interface

	// CachingClientSet allows us to instantiate Image objects
	CachingClientSet cachingclientset.Interface

	// ConfigMapWatcher allows us to watch for ConfigMap changes.
	ConfigMapWatcher configmap.Watcher

	// Recorder is an event recorder for recording Event resources to the
	// Kubernetes API.
	Recorder record.EventRecorder

	// StatsReporter reports reconciler's metrics.
	StatsReporter StatsReporter

	// Sugared logger is easier to use but is not as performant as the
	// raw logger. In performance critical paths, call logger.Desugar()
	// and use the returned raw logger instead. In addition to the
	// performance benefits, raw logger also preserves type-safety at
	// the expense of slightly greater verbosity.
	Logger *zap.SugaredLogger
}

Base implements the core controller logic, given a Reconciler.

func NewBase

func NewBase(opt Options, controllerAgentName string) *Base

NewBase instantiates a new instance of Base implementing the common & boilerplate code between our reconcilers.

type Measurement

type Measurement int

type Options

type Options struct {
	KubeClientSet    kubernetes.Interface
	SharedClientSet  sharedclientset.Interface
	DynamicClientSet dynamic.Interface
	ScaleClientSet   scale.ScalesGetter

	ServingClientSet clientset.Interface
	CachingClientSet cachingclientset.Interface

	Recorder      record.EventRecorder
	StatsReporter StatsReporter

	ConfigMapWatcher configmap.Watcher
	Logger           *zap.SugaredLogger

	ResyncPeriod time.Duration
	StopChannel  <-chan struct{}
}

Options defines the common reconciler options. We define this to reduce the boilerplate argument list when creating our controllers.

func NewOptionsOrDie

func NewOptionsOrDie(cfg *rest.Config, logger *zap.SugaredLogger, stopCh <-chan struct{}) Options

func (Options) GetTrackerLease

func (o Options) GetTrackerLease() time.Duration

GetTrackerLease returns a multiple of the resync period to use as the duration for tracker leases. This attempts to ensure that resyncs happen to refresh leases frequently enough that we don't miss updates to tracked objects.

type StatsReporter

type StatsReporter interface {
	// ReportServiceReady reports the time it took a service to become Ready.
	ReportServiceReady(namespace, service string, d time.Duration) error
}

StatsReporter reports reconcilers' metrics.

func NewStatsReporter

func NewStatsReporter(reconciler string) (StatsReporter, error)

NewStatsReporter creates a reporter for reconcilers' metrics