definition

Documentation

Overview

Package definition manages the lifecycle of XR controllers.

Index

• func CompositeReconcilerOptions(co apiextensionscontroller.Options, d *v1.CompositeResourceDefinition, ...) []composite.ReconcilerOption
• func IndexCompositeResourceRefGVKs(o client.Object) []string
• func IndexCompositeResourcesRefs(o client.Object) []string
• 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 Reconciler
  • func NewReconciler(mgr manager.Manager, o apiextensionscontroller.Options, ...) *Reconciler
  • func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
• type ReconcilerOption
  • func WithCRDRenderer(c CRDRenderer) ReconcilerOption
  • func WithClientApplicator(ca resource.ClientApplicator) ReconcilerOption
  • func WithControllerEngine(c ControllerEngine) ReconcilerOption
  • func WithFinalizer(f resource.Finalizer) ReconcilerOption
  • func WithLogger(log logging.Logger) ReconcilerOption
  • func WithRecorder(er event.Recorder) ReconcilerOption

Functions

func CompositeReconcilerOptions

func CompositeReconcilerOptions(co apiextensionscontroller.Options, d *v1.CompositeResourceDefinition, c client.Client, l logging.Logger, e event.Recorder) []composite.ReconcilerOption

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

func IndexCompositeResourceRefGVKs

func IndexCompositeResourceRefGVKs(o client.Object) []string

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

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 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 {
	IsRunning(name string) bool
	Create(name string, o kcontroller.Options, w ...controller.Watch) (controller.NamedController, error)
	Start(name string, o kcontroller.Options, w ...controller.Watch) error
	Stop(name string)
	Err(name string) error
}

A ControllerEngine can start and stop Kubernetes controllers on demand.

type Reconciler

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

A Reconciler reconciles CompositeResourceDefinitions.

func NewReconciler

func NewReconciler(mgr manager.Manager, o apiextensionscontroller.Options, opts ...ReconcilerOption) *Reconciler

NewReconciler returns a Reconciler of CompositeResourceDefinitions.

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 WithClientApplicator

func WithClientApplicator(ca resource.ClientApplicator) ReconcilerOption

WithClientApplicator specifies how the Reconciler should interact with the Kubernetes API.

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 WithRecorder

func WithRecorder(er event.Recorder) ReconcilerOption

WithRecorder specifies how the Reconciler should record Kubernetes events.