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 ChainFilterFuncs(funcs ...func(interface{}) bool) func(interface{}) bool
• func LabelExistsFilterFunc(label string) func(obj interface{}) bool
• func LabelFilterFunc(label string, value string, allowUnset bool) func(interface{}) bool
• func NameFilterFunc(name string) func(interface{}) bool
• func NamespaceFilterFunc(namespace string) func(interface{}) bool
• func WithStatsReporter(ctx context.Context, sr StatsReporter) context.Context
• type Base
  • func NewBase(ctx context.Context, controllerAgentName string, cmw configmap.Watcher) *Base
  • func (b *Base) MarkNeedsUpgrade(gvr schema.GroupVersionResource, namespace, name string) error
• type ConfigStore
• type StatsReporter
  • func GetStatsReporter(ctx context.Context) 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"
)

const (
	ForceUpgradePatch = `[{
  "op":"add",
  "path":"/metadata/annotations/serving.knative.dev~1forceUpgrade",
  "value":"true"
}]`
)

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 ChainFilterFuncs

func ChainFilterFuncs(funcs ...func(interface{}) bool) func(interface{}) bool

ChainFilterFuncs creates a FilterFunc which performs an AND of the passed FilterFuncs.

func LabelExistsFilterFunc

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

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

func LabelFilterFunc

func LabelFilterFunc(label string, value string, allowUnset bool) func(interface{}) bool

LabelFilterFunc creates a FilterFunc only accepting objects where a label is set to a specific value.

func NameFilterFunc

func NameFilterFunc(name string) func(interface{}) bool

NameFilterFunc creates a FilterFunc only accepting objects with the given name.

func NamespaceFilterFunc

func NamespaceFilterFunc(namespace string) func(interface{}) bool

NamespaceFilterFunc creates a FilterFunc only accepting objects in the given namespace.

func WithStatsReporter

func WithStatsReporter(ctx context.Context, sr StatsReporter) context.Context

WithStatsReporter attaches the given StatsReporter to the provided context in the returned context.

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(ctx context.Context, controllerAgentName string, cmw configmap.Watcher) *Base

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

func (*Base) MarkNeedsUpgrade

func (b *Base) MarkNeedsUpgrade(gvr schema.GroupVersionResource, namespace, name string) error

type ConfigStore

type ConfigStore interface {
	ToContext(ctx context.Context) context.Context
}

ConfigStore is a minimal interface to the config stores used by our controllers.

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 GetStatsReporter

func GetStatsReporter(ctx context.Context) StatsReporter

GetStatsReporter attempts to look up the StatsReporter on a given context. It may return null if none is found.

func NewStatsReporter

func NewStatsReporter(reconciler string) (StatsReporter, error)

NewStatsReporter creates a reporter for reconcilers' metrics