resource

Documentation

Index

• Constants
• type ChildResource
• type ChildResourcePatcher
• type ChildResourcePatcherChain
  • func (pre ChildResourcePatcherChain) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)
• type ChildResourcePatcherFunc
  • func (pre ChildResourcePatcherFunc) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)
• type DefaultingAnnotationRemover
  • func NewDefaultingAnnotationRemover() DefaultingAnnotationRemover
  • func (lo DefaultingAnnotationRemover) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)
• type OwnerReferenceAdder
  • func NewOwnerReferenceAdder() OwnerReferenceAdder
  • func (lo OwnerReferenceAdder) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)
• type ParentResource
• type TemplatingEngine

Constants

const KeepDefaultAnnotationsKey = "resourcepacks.crossplane.io/keep-defaulting-annotations"

const KeepDefaultAnnotationsTrueValue = "true"

Types

type ChildResource

type ChildResource interface {
	runtime.Object
	metav1.Object
}

ChildResource is satisfied by all Kubernetes objects that the stack may want to render and deploy.

type ChildResourcePatcher

type ChildResourcePatcher interface {
	Patch(ParentResource, []ChildResource) ([]ChildResource, error)
}

ChildResourcePatcher operates on the resources rendered by the templating engine.

type ChildResourcePatcherChain

type ChildResourcePatcherChain []ChildResourcePatcher

ChildResourcePatcherChain makes it easier to provide a list of ChildResourcePatcher to be called in order.

func (ChildResourcePatcherChain) Patch

func (pre ChildResourcePatcherChain) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)

type ChildResourcePatcherFunc

type ChildResourcePatcherFunc func(ParentResource, []ChildResource) ([]ChildResource, error)

ChildResourcePatcherFunc makes it easier to provide only a function as ChildResourcePatcher

func (ChildResourcePatcherFunc) Patch

func (pre ChildResourcePatcherFunc) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)

type DefaultingAnnotationRemover

type DefaultingAnnotationRemover struct{}

DefaultingAnnotationRemover removes the defaulting annotation on the resources if not explicitly specified otherwise.

func NewDefaultingAnnotationRemover

func NewDefaultingAnnotationRemover() DefaultingAnnotationRemover

NewDefaultingAnnotationRemover returns a new DefaultingAnnotationRemover

func (DefaultingAnnotationRemover) Patch

func (lo DefaultingAnnotationRemover) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)

type OwnerReferenceAdder

type OwnerReferenceAdder struct{}

OwnerReferenceAdder adds owner reference of ParentResource to all ChildResources except the Providers since their deletion should be delayed until all resources refer to them are deleted.

func NewOwnerReferenceAdder

func NewOwnerReferenceAdder() OwnerReferenceAdder

NewOwnerReferenceAdder returns a new *OwnerReferenceAdder

func (OwnerReferenceAdder) Patch

func (lo OwnerReferenceAdder) Patch(cr ParentResource, list []ChildResource) ([]ChildResource, error)

type ParentResource

type ParentResource interface {
	runtime.Object
	metav1.Object

	resource.Conditioned
}

ParentResource should be satisfied by the stack CRD that would like to use generic Resource Pack Reconciler.

type TemplatingEngine

type TemplatingEngine interface {
	Run(ParentResource) ([]ChildResource, error)
}