resource

Documentation

Index

• func Ignore(is ErrorIs, err error) error
• func IgnoreAny(err error, is ...ErrorIs) error
• func IgnoreNotFound(err error) error
• func IgnoreUpdateWithoutGenerationChangePredicate() predicate.Predicate
• func IsAPIError(err error) bool
• func IsAPIErrorWrapped(err error) bool
• func IsNotAllowed(err error) bool
• func NewPredicates(fn PredicateFn) predicate.Funcs
• type APIFinalizer
  • func NewAPIFinalizer(c client.Client, finalizer string) *APIFinalizer
  • func (a *APIFinalizer) AddFinalizer(ctx context.Context, obj Object) error
  • func (a *APIFinalizer) RemoveFinalizer(ctx context.Context, obj Object) error
• type APIPatchingApplicator
  • func NewAPIPatchingApplicator(c client.Client) *APIPatchingApplicator
  • func (a *APIPatchingApplicator) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error
• type APIUpdatingApplicator
  • func NewAPIUpdatingApplicator(c client.Client) *APIUpdatingApplicator
  • func (a *APIUpdatingApplicator) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error
• type Active
• type Applicator
• type ApplyFn
  • func (fn ApplyFn) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error
• type ApplyOption
  • func AllowUpdateIf(fn func(current, desired runtime.Object) bool) ApplyOption
  • func MustBeControllableBy(u types.UID) ApplyOption
  • func UpdateFn(fn func(current, desired runtime.Object)) ApplyOption
• type ClientApplicator
• type Conditioned
• type ErrorIs
• type Finalizer
• type FinalizerFns
  • func (f FinalizerFns) AddFinalizer(ctx context.Context, obj Object) error
  • func (f FinalizerFns) RemoveFinalizer(ctx context.Context, obj Object) error
• type Managed
• type ManagedList
• type Object
• type Orphanable
• type PredicateFn
• type RequiredTargetConfigReferencer
• type RequiredTypedResourceReferencer
• type TargetConditioned
• type TargetConfig
• type TargetConfigReferencer
• type TargetConfigUsage
• type TargetConfigUsageList

Functions

func Ignore

func Ignore(is ErrorIs, err error) error

Ignore any errors that satisfy the supplied ErrorIs function by returning nil. Errors that do not satisfy the supplied function are returned unmodified.

func IgnoreAny

func IgnoreAny(err error, is ...ErrorIs) error

IgnoreAny ignores errors that satisfy any of the supplied ErrorIs functions by returning nil. Errors that do not satisfy any of the supplied functions are returned unmodified.

func IgnoreNotFound

func IgnoreNotFound(err error) error

IgnoreNotFound returns the supplied error, or nil if the error indicates a Kubernetes resource was not found.

func IgnoreUpdateWithoutGenerationChangePredicate

func IgnoreUpdateWithoutGenerationChangePredicate() predicate.Predicate

func IsAPIError

func IsAPIError(err error) bool

IsAPIError returns true if the given error's type is of Kubernetes API error.

func IsAPIErrorWrapped

func IsAPIErrorWrapped(err error) bool

IsAPIErrorWrapped returns true if err is a K8s API error, or recursively wraps a K8s API error

func IsNotAllowed

func IsNotAllowed(err error) bool

IsNotAllowed returns true if the supplied error indicates that an operation was not allowed.

func NewPredicates

func NewPredicates(fn PredicateFn) predicate.Funcs

NewPredicates returns a set of Funcs that are all satisfied by the supplied PredicateFn. The PredicateFn is run against the new object during updates.

Types

type APIFinalizer

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

An APIFinalizer adds and removes finalizers to and from a resource.

func NewAPIFinalizer

func NewAPIFinalizer(c client.Client, finalizer string) *APIFinalizer

NewAPIFinalizer returns a new APIFinalizer.

func (*APIFinalizer) AddFinalizer

func (a *APIFinalizer) AddFinalizer(ctx context.Context, obj Object) error

AddFinalizer to the supplied Managed resource.

func (*APIFinalizer) RemoveFinalizer

func (a *APIFinalizer) RemoveFinalizer(ctx context.Context, obj Object) error

RemoveFinalizer from the supplied Managed resource.

type APIPatchingApplicator

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

An APIPatchingApplicator applies changes to an object by either creating or patching it in a Kubernetes API server.

func NewAPIPatchingApplicator

func NewAPIPatchingApplicator(c client.Client) *APIPatchingApplicator

NewAPIPatchingApplicator returns an Applicator that applies changes to an object by either creating or patching it in a Kubernetes API server.

func (*APIPatchingApplicator) Apply

func (a *APIPatchingApplicator) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error

Apply changes to the supplied object. The object will be created if it does not exist, or patched if it does. If the object does exist, it will only be patched if the passed object has the same or an empty resource version.

type APIUpdatingApplicator

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

An APIUpdatingApplicator applies changes to an object by either creating or updating it in a Kubernetes API server.

func NewAPIUpdatingApplicator

func NewAPIUpdatingApplicator(c client.Client) *APIUpdatingApplicator

NewAPIUpdatingApplicator returns an Applicator that applies changes to an object by either creating or updating it in a Kubernetes API server.

func (*APIUpdatingApplicator) Apply

func (a *APIUpdatingApplicator) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error

Apply changes to the supplied object. The object will be created if it does not exist, or updated if it does.

type Active

type Active interface {
	SetActive(p bool)
	GetActive() bool
}

An Orphanable resource may specify a DeletionPolicy.

type Applicator

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

An Applicator applies changes to an object.

type ApplyFn

type ApplyFn func(context.Context, client.Object, ...ApplyOption) error

An ApplyFn is a function that satisfies the Applicator interface.

func (ApplyFn) Apply

func (fn ApplyFn) Apply(ctx context.Context, o client.Object, ao ...ApplyOption) error

Apply changes to the supplied object.

type ApplyOption

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

An ApplyOption is called before patching the current object to match the desired object. ApplyOptions are not called if no current object exists.

func AllowUpdateIf

func AllowUpdateIf(fn func(current, desired runtime.Object) bool) ApplyOption

AllowUpdateIf will only update the current object if the supplied fn returns true. An error that satisfies IsNotAllowed will be returned if the supplied function returns false. Creation of a desired object that does not currently exist is always allowed.

func MustBeControllableBy

func MustBeControllableBy(u types.UID) ApplyOption

MustBeControllableBy requires that the current object is controllable by an object with the supplied UID. An object is controllable if its controller reference matches the supplied UID, or it has no controller reference. An error that satisfies IsNotControllable will be returned if the current object cannot be controlled by the supplied UID.

func UpdateFn

func UpdateFn(fn func(current, desired runtime.Object)) ApplyOption

UpdateFn returns an ApplyOption that is used to modify the current object to match fields of the desired.

type ClientApplicator

type ClientApplicator struct {
	client.Client
	Applicator
}

A ClientApplicator may be used to build a single 'client' that satisfies both client.Client and Applicator.

type Conditioned

type Conditioned interface {
	SetConditions(c ...nddv1.Condition)
	GetCondition(ck nddv1.ConditionKind) nddv1.Condition
}

A Conditioned may have conditions set or retrieved. Conditions are typically indicate the status of both a resource and its reconciliation process.

type ErrorIs

type ErrorIs func(err error) bool

An ErrorIs function returns true if an error satisfies a particular condition.

type Finalizer

type Finalizer interface {
	AddFinalizer(ctx context.Context, obj Object) error
	RemoveFinalizer(ctx context.Context, obj Object) error
}

A Finalizer manages the finalizers on the resource.

type FinalizerFns

type FinalizerFns struct {
	AddFinalizerFn    func(ctx context.Context, obj Object) error
	RemoveFinalizerFn func(ctx context.Context, obj Object) error
}

A FinalizerFns satisfy the Finalizer interface.

func (FinalizerFns) AddFinalizer

func (f FinalizerFns) AddFinalizer(ctx context.Context, obj Object) error

AddFinalizer to the supplied resource.

func (FinalizerFns) RemoveFinalizer

func (f FinalizerFns) RemoveFinalizer(ctx context.Context, obj Object) error

RemoveFinalizer from the supplied resource.

type Managed

type Managed interface {
	Object

	TargetConfigReferencer
	Orphanable
	Active

	Conditioned
}

A Managed is a Kubernetes object representing a concrete managed resource (e.g. a CloudSQL instance).

type ManagedList

type ManagedList interface {
	client.ObjectList

	// GetItems returns the list of managed resources.
	GetItems() []Managed
}

A ManagedList is a list of managed resources.

type Object

type Object interface {
	metav1.Object
	runtime.Object
}

An Object is a Kubernetes object.

type Orphanable

type Orphanable interface {
	SetDeletionPolicy(p nddv1.DeletionPolicy)
	GetDeletionPolicy() nddv1.DeletionPolicy
}

An Orphanable resource may specify a DeletionPolicy.

type PredicateFn

type PredicateFn func(obj runtime.Object) bool

A PredicateFn returns true if the supplied object should be reconciled.

type RequiredTargetConfigReferencer

type RequiredTargetConfigReferencer interface {
	GetTargetConfigReference() nddv1.Reference
	SetTargetConfigReference(p nddv1.Reference)
}

A RequiredTargetConfigReferencer may reference a Target config resource. Unlike TargetConfigReferencer, the reference is required (i.e. not nil).

type RequiredTypedResourceReferencer

type RequiredTypedResourceReferencer interface {
	SetResourceReference(r nddv1.TypedReference)
	GetResourceReference() nddv1.TypedReference
}

A RequiredTypedResourceReferencer can reference a resource.

type TargetConditioned

type TargetConditioned interface {
	SetTargetConditions(target string, c ...nddv1.Condition)
	GetTargetCondition(target string, ck nddv1.ConditionKind) nddv1.Condition
}

A TargetConditioned may have conditions set or retrieved. TargetConditioned are typically indicate the status of both a resource and its reconciliation process.

type TargetConfig

type TargetConfig interface {
	Object

	Conditioned
}

A TargetConfig configures a Network Device Driver Target.

type TargetConfigReferencer

type TargetConfigReferencer interface {
	GetTargetConfigReference() *nddv1.Reference
	SetTargetConfigReference(p *nddv1.Reference)
}

A TargetConfigReferencer may reference a Target config resource.

type TargetConfigUsage

type TargetConfigUsage interface {
	Object

	RequiredTargetConfigReferencer
	RequiredTypedResourceReferencer
}

A TargetConfigUsage indicates a usage of a ndd target config.

type TargetConfigUsageList

type TargetConfigUsageList interface {
	client.ObjectList

	// GetItems returns the list of Target config usages.
	GetItems() []TargetConfigUsage
}

A TargetConfigUsageList is a list of Target config usages.