definition

Documentation

Overview

Package definition manages the lifecycle of XR controllers.

Index

• func EnqueueCompositeResources(of resource.CompositeKind, c client.Reader, log logging.Logger) handler.Funcs
• func EnqueueForCompositionRevision(of resource.CompositeKind, c client.Reader, log logging.Logger) handler.Funcs
• func IndexCompositeResourcesRefs(o client.Object) []string
• func IsCompositeResourceCRD() resource.PredicateFn
• func NewClientApplicator(c client.Client) resource.ClientApplicator
• func Setup(mgr ctrl.Manager, o apiextensionscontroller.Options) error
• type CRDRenderFn
  • func (fn CRDRenderFn) Render(d *v1.CompositeResourceDefinition) (*extv1.CustomResourceDefinition, error)
• type CRDRenderer
• type ControllerEngine
• type NopEngine
  • func (e *NopEngine) GetClient() client.Client
  • func (e *NopEngine) GetFieldIndexer() client.FieldIndexer
  • func (e *NopEngine) GetWatches(_ string) ([]engine.WatchID, error)
  • func (e *NopEngine) IsRunning(_ string) bool
  • func (e *NopEngine) Start(_ string, _ ...engine.ControllerOption) error
  • func (e *NopEngine) StartWatches(_ string, _ ...engine.Watch) error
  • func (e *NopEngine) Stop(_ context.Context, _ string) error
  • func (e *NopEngine) StopWatches(_ context.Context, _ string, _ ...engine.WatchID) (int, error)
• type Reconciler
  • func NewReconciler(ca resource.ClientApplicator, opts ...ReconcilerOption) *Reconciler
  • func (r *Reconciler) CompositeReconcilerOptions(ctx context.Context, d *v1.CompositeResourceDefinition) []composite.ReconcilerOption
  • func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
• type ReconcilerOption
  • func WithCRDRenderer(c CRDRenderer) ReconcilerOption
  • func WithControllerEngine(c ControllerEngine) ReconcilerOption
  • func WithFinalizer(f resource.Finalizer) ReconcilerOption
  • func WithLogger(log logging.Logger) ReconcilerOption
  • func WithOptions(o apiextensionscontroller.Options) ReconcilerOption
  • func WithRecorder(er event.Recorder) ReconcilerOption

Functions

func EnqueueCompositeResources

func EnqueueCompositeResources(of resource.CompositeKind, c client.Reader, log logging.Logger) handler.Funcs

EnqueueCompositeResources enqueues reconciles for all XRs that reference an updated composed resource.

func EnqueueForCompositionRevision

func EnqueueForCompositionRevision(of resource.CompositeKind, c client.Reader, log logging.Logger) handler.Funcs

EnqueueForCompositionRevision enqueues reconciles for all XRs that will use a newly created CompositionRevision.

func IndexCompositeResourcesRefs

func IndexCompositeResourcesRefs(o client.Object) []string

IndexCompositeResourcesRefs assumes the passed object is a composite. It returns keys for every composed resource referenced in the composite.

func IsCompositeResourceCRD

func IsCompositeResourceCRD() resource.PredicateFn

IsCompositeResourceCRD accepts any CustomResourceDefinition that represents a Composite Resource.

func NewClientApplicator

func NewClientApplicator(c client.Client) resource.ClientApplicator

NewClientApplicator returns a ClientApplicator suitable for use by the definition controller.

func Setup

func Setup(mgr ctrl.Manager, o apiextensionscontroller.Options) error

Setup adds a controller that reconciles CompositeResourceDefinitions by defining a composite resource and starting a controller to reconcile it.

Types

type CRDRenderFn

type CRDRenderFn func(d *v1.CompositeResourceDefinition) (*extv1.CustomResourceDefinition, error)

A CRDRenderFn renders a CompositeResourceDefinition's corresponding CustomResourceDefinition.

func (CRDRenderFn) Render

func (fn CRDRenderFn) Render(d *v1.CompositeResourceDefinition) (*extv1.CustomResourceDefinition, error)

Render the supplied CompositeResourceDefinition's corresponding CustomResourceDefinition.

type CRDRenderer

type CRDRenderer interface {
	Render(d *v1.CompositeResourceDefinition) (*extv1.CustomResourceDefinition, error)
}

A CRDRenderer renders a CompositeResourceDefinition's corresponding CustomResourceDefinition.

type ControllerEngine

type ControllerEngine interface {
	Start(name string, o ...engine.ControllerOption) error
	Stop(ctx context.Context, name string) error
	IsRunning(name string) bool
	GetWatches(name string) ([]engine.WatchID, error)
	StartWatches(name string, ws ...engine.Watch) error
	StopWatches(ctx context.Context, name string, ws ...engine.WatchID) (int, error)
	GetClient() client.Client
	GetFieldIndexer() client.FieldIndexer
}

A ControllerEngine can start and stop Kubernetes controllers on demand.

type NopEngine

type NopEngine struct{}

A NopEngine does nothing.

func (*NopEngine) GetClient

func (e *NopEngine) GetClient() client.Client

GetClient returns a nil client.

func (*NopEngine) GetFieldIndexer

func (e *NopEngine) GetFieldIndexer() client.FieldIndexer

GetFieldIndexer returns a nil field indexer.

func (*NopEngine) GetWatches

func (e *NopEngine) GetWatches(_ string) ([]engine.WatchID, error)

GetWatches does nothing.

func (*NopEngine) IsRunning

func (e *NopEngine) IsRunning(_ string) bool

IsRunning always returns true.

func (*NopEngine) Start

func (e *NopEngine) Start(_ string, _ ...engine.ControllerOption) error

Start does nothing.

func (*NopEngine) StartWatches

func (e *NopEngine) StartWatches(_ string, _ ...engine.Watch) error

StartWatches does nothing.

func (*NopEngine) Stop

func (e *NopEngine) Stop(_ context.Context, _ string) error

Stop does nothing.

func (*NopEngine) StopWatches

func (e *NopEngine) StopWatches(_ context.Context, _ string, _ ...engine.WatchID) (int, error)

StopWatches does nothing.

type Reconciler

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

A Reconciler reconciles CompositeResourceDefinitions.

func NewReconciler

func NewReconciler(ca resource.ClientApplicator, opts ...ReconcilerOption) *Reconciler

NewReconciler returns a Reconciler of CompositeResourceDefinitions.

func (*Reconciler) CompositeReconcilerOptions

func (r *Reconciler) CompositeReconcilerOptions(ctx context.Context, d *v1.CompositeResourceDefinition) []composite.ReconcilerOption

CompositeReconcilerOptions builds the options for a composite resource reconciler. The options vary based on the supplied feature flags.

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

Reconcile a CompositeResourceDefinition by defining a new kind of composite resource and starting a controller to reconcile it.

type ReconcilerOption

type ReconcilerOption func(*Reconciler)

ReconcilerOption is used to configure the Reconciler.

func WithCRDRenderer

func WithCRDRenderer(c CRDRenderer) ReconcilerOption

WithCRDRenderer specifies how the Reconciler should render an CompositeResourceDefinition's corresponding CustomResourceDefinition.

func WithControllerEngine

func WithControllerEngine(c ControllerEngine) ReconcilerOption

WithControllerEngine specifies how the Reconciler should manage the lifecycles of composite controllers.

func WithFinalizer

func WithFinalizer(f resource.Finalizer) ReconcilerOption

WithFinalizer specifies how the Reconciler should finalize CompositeResourceDefinitions.

func WithLogger

func WithLogger(log logging.Logger) ReconcilerOption

WithLogger specifies how the Reconciler should log messages.

func WithOptions

func WithOptions(o apiextensionscontroller.Options) ReconcilerOption

WithOptions lets the Reconciler know which options to pass to new composite resource controllers.

func WithRecorder

func WithRecorder(er event.Recorder) ReconcilerOption

WithRecorder specifies how the Reconciler should record Kubernetes events.