apply

Documentation

Index

• type APIApplicator
  • func NewAPIApplicator(c client.Client) *APIApplicator
  • func (a *APIApplicator) Apply(ctx context.Context, desired runtime.Object, ao ...ApplyOption) error
• type Applicator
• type ApplyOption
  • func MustBeControllableBy(u types.UID) ApplyOption
  • func MustBeControllableByAny(ctrlUIDs []types.UID) ApplyOption

Types

type APIApplicator

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

APIApplicator implements Applicator

func NewAPIApplicator

func NewAPIApplicator(c client.Client) *APIApplicator

NewAPIApplicator creates an Applicator that applies state to an object or creates the object if not exist.

func (*APIApplicator) Apply

func (a *APIApplicator) Apply(ctx context.Context, desired runtime.Object, ao ...ApplyOption) error

Apply applies new state to an object or create it if not exist

type Applicator

type Applicator interface {
	Apply(context.Context, runtime.Object, ...ApplyOption) error
}

Applicator applies new state to an object or create it if not exist. It uses the same mechanism as `kubectl apply`, that is, for each resource being applied, computing a three-way diff merge in client side based on its current state, modified stated, and last-applied-state which is tracked through an specific annotation. If the resource doesn't exist before, Apply will create it.

type ApplyOption

type ApplyOption func(ctx context.Context, existing, desired runtime.Object) error

ApplyOption is called before applying state to the object. ApplyOption is still called even if the object does NOT exist. If the object does not exist, `existing` will be assigned as `nil`. nolint: golint

func MustBeControllableBy

func MustBeControllableBy(u types.UID) ApplyOption

MustBeControllableBy requires that the new object is controllable by an object with the supplied UID. An object is controllable if its controller reference includes the supplied UID.

func MustBeControllableByAny

func MustBeControllableByAny(ctrlUIDs []types.UID) ApplyOption

MustBeControllableByAny requires that the new object is controllable by any of the object with the supplied UID.