composed

Documentation

Index

• Constants
• func IsReady(_ context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (bool, error)
• type APIConnectionDetailsFetcher
  • func (cdf *APIConnectionDetailsFetcher) Fetch(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)
• type Composer
  • func NewComposer(kube client.Client, opts ...ComposerOption) *Composer
  • func (r *Composer) Compose(ctx context.Context, cp resource.Composite, cd resource.Composed, ...) (Observation, error)
• type ComposerOption
  • func WithClientApplicator(ca resource.ClientApplicator) ComposerOption
  • func WithConfigurator(c Configurator) ComposerOption
  • func WithConnectionDetailFetcher(cdf ConnectionDetailsFetcher) ComposerOption
  • func WithOverlayApplicator(oa OverlayApplicator) ComposerOption
• type Configurator
• type ConfigureFn
  • func (c ConfigureFn) Configure(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
• type ConnectionDetailsFetcher
• type DefaultConfigurator
  • func (*DefaultConfigurator) Configure(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
• type DefaultOverlayApplicator
  • func (*DefaultOverlayApplicator) Overlay(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
• type FetchFn
  • func (f FetchFn) Fetch(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)
• type Observation
• type OverlayApplicator
• type OverlayFn
  • func (o OverlayFn) Overlay(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
• type ReadinessCheckFn
  • func (fn ReadinessCheckFn) IsReady(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (ready bool, err error)
• type ReadinessChecker

Constants

const (
	LabelKeyNamePrefixForComposed = "crossplane.io/composite"
	LabelKeyClaimName             = "crossplane.io/claim-name"
	LabelKeyClaimNamespace        = "crossplane.io/claim-namespace"
)

Label keys.

Functions

func IsReady

func IsReady(_ context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (bool, error)

IsReady returns whether the composed resource is ready.

Types

type APIConnectionDetailsFetcher

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

APIConnectionDetailsFetcher fetches the connection secret of given composed resource if it has a connection secret reference.

func (*APIConnectionDetailsFetcher) Fetch

func (cdf *APIConnectionDetailsFetcher) Fetch(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)

Fetch returns the connection secret details of composed resource.

type Composer

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

An Composer composes infrastructure resources in a Kubernetes API server.

func NewComposer

func NewComposer(kube client.Client, opts ...ComposerOption) *Composer

NewComposer returns a new Composer that composes infrastructure resources in a Kubernetes API server.

func (*Composer) Compose

func (r *Composer) Compose(ctx context.Context, cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) (Observation, error)

Compose the supplied Composed resource into the supplied Composite resource using the supplied CompositeTemplate.

type ComposerOption

type ComposerOption func(*Composer)

ComposerOption configures the Composer object.

func WithClientApplicator

func WithClientApplicator(ca resource.ClientApplicator) ComposerOption

WithClientApplicator returns a ComposerOption that changes the ClientApplicator of Composer.

func WithConfigurator

func WithConfigurator(c Configurator) ComposerOption

WithConfigurator returns a ComposerOption that changes the Configurator of Composer.

func WithConnectionDetailFetcher

func WithConnectionDetailFetcher(cdf ConnectionDetailsFetcher) ComposerOption

WithConnectionDetailFetcher returns a ComposerOption that changes the ConnectionDetailsFetcher of Composer.

func WithOverlayApplicator

func WithOverlayApplicator(oa OverlayApplicator) ComposerOption

WithOverlayApplicator returns a ComposerOption that changes the OverlayApplicator of Composer.

type Configurator

type Configurator interface {
	Configure(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
}

Configurator is used to configure the Composed resource.

type ConfigureFn

type ConfigureFn func(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

ConfigureFn is a function that implements Configurator interface.

func (ConfigureFn) Configure

func (c ConfigureFn) Configure(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

Configure calls ConfigureFn.

type ConnectionDetailsFetcher

type ConnectionDetailsFetcher interface {
	Fetch(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)
}

ConnectionDetailsFetcher fetches the connection details of the Composed resource.

type DefaultConfigurator

type DefaultConfigurator struct{}

DefaultConfigurator configures the composed resource with given raw template and metadata information from composite resource.

func (*DefaultConfigurator) Configure

func (*DefaultConfigurator) Configure(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

Configure applies the raw template and sets name and generateName.

type DefaultOverlayApplicator

type DefaultOverlayApplicator struct{}

DefaultOverlayApplicator applies patches to the composed resource using the values on Composite resource and field bindings in ComposedTemplate.

func (*DefaultOverlayApplicator) Overlay

func (*DefaultOverlayApplicator) Overlay(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

Overlay applies patches to composed resource.

type FetchFn

type FetchFn func(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)

FetchFn is a function that implements the ConnectionDetailsFetcher interface.

func (FetchFn) Fetch

func (f FetchFn) Fetch(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (managed.ConnectionDetails, error)

Fetch calls FetchFn.

type Observation

type Observation struct {
	Ref               corev1.ObjectReference
	ConnectionDetails managed.ConnectionDetails
	Ready             bool
}

Observation is the result of composed reconciliation.

type OverlayApplicator

type OverlayApplicator interface {
	Overlay(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error
}

OverlayApplicator is used to apply an overlay at each reconcile.

type OverlayFn

type OverlayFn func(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

OverlayFn is a function that implements OverlayApplicator interface.

func (OverlayFn) Overlay

func (o OverlayFn) Overlay(cp resource.Composite, cd resource.Composed, t v1beta1.ComposedTemplate) error

Overlay calls OverlayFn.

type ReadinessCheckFn

type ReadinessCheckFn func(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (ready bool, err error)

A ReadinessCheckFn checks whether a composed resource is ready or not.

func (ReadinessCheckFn) IsReady

func (fn ReadinessCheckFn) IsReady(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (ready bool, err error)

IsReady reports whether a composed resource is ready or not.

type ReadinessChecker

type ReadinessChecker interface {
	IsReady(ctx context.Context, cd resource.Composed, t v1beta1.ComposedTemplate) (ready bool, err error)
}

A ReadinessChecker checks whether a composed resource is ready or not.