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 MustCreateObject(kind schema.GroupVersionKind, oc runtime.ObjectCreater) runtime.Object
- func NewPredicates(fn PredicateFn) predicate.Funcs
- type APIFinalizer
- func (a *APIFinalizer) AddFinalizer(ctx context.Context, obj Object) error
- func (a *APIFinalizer) AddFinalizerString(ctx context.Context, obj Object, finalizerString string) error
- func (a *APIFinalizer) HasOtherFinalizer(ctx context.Context, obj Object) (bool, error)
- func (a *APIFinalizer) RemoveFinalizer(ctx context.Context, obj Object) error
- func (a *APIFinalizer) RemoveFinalizerString(ctx context.Context, obj Object, finalizerString string) error
- type APIPatchingApplicator
- type APIUpdatingApplicator
- type Applicator
- type ApplyFn
- type ApplyOption
- type ClientApplicator
- type Conditioned
- type DeviceConditioned
- type ErrorIs
- type Finalizer
- type FinalizerFns
- func (f FinalizerFns) AddFinalizer(ctx context.Context, obj Object) error
- func (f FinalizerFns) AddFinalizerString(ctx context.Context, obj Object, finalizerString string) error
- func (f FinalizerFns) HasOtherFinalizer(ctx context.Context, obj Object) (bool, error)
- func (f FinalizerFns) RemoveFinalizer(ctx context.Context, obj Object) error
- func (f FinalizerFns) RemoveFinalizerString(ctx context.Context, obj Object, finalizerString string) error
- type Generation
- type Object
- type PredicateFn
- type Transaction
- type TransactionKind
- type TransactionList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Ignore ¶
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 ¶
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 ¶
IgnoreNotFound returns the supplied error, or nil if the error indicates a Kubernetes resource was not found.
func IsAPIError ¶
IsAPIError returns true if the given error's type is of Kubernetes API error.
func IsAPIErrorWrapped ¶
IsAPIErrorWrapped returns true if err is a K8s API error, or recursively wraps a K8s API error
func MustCreateObject ¶
func MustCreateObject(kind schema.GroupVersionKind, oc runtime.ObjectCreater) runtime.Object
MustCreateObject returns a new Object of the supplied kind. It panics if the kind is unknown to the supplied ObjectCreator.
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) AddFinalizerString ¶
func (a *APIFinalizer) AddFinalizerString(ctx context.Context, obj Object, finalizerString string) error
AddFinalizer to the supplied Managed resource.
func (*APIFinalizer) HasOtherFinalizer ¶
func (*APIFinalizer) RemoveFinalizer ¶
func (a *APIFinalizer) RemoveFinalizer(ctx context.Context, obj Object) error
RemoveFinalizer from the supplied Managed resource.
func (*APIFinalizer) RemoveFinalizerString ¶
func (a *APIFinalizer) RemoveFinalizerString(ctx context.Context, obj Object, finalizerString string) 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 Applicator ¶
An Applicator applies changes to an object.
type ApplyOption ¶
An ApplyOption is called before patching the current object to match the desired object. ApplyOptions are not called if no current object exists.
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 DeviceConditioned ¶
type Finalizer ¶
type Finalizer interface { AddFinalizer(ctx context.Context, obj Object) error RemoveFinalizer(ctx context.Context, obj Object) error HasOtherFinalizer(ctx context.Context, obj Object) (bool, error) AddFinalizerString(ctx context.Context, obj Object, finalizerString string) error RemoveFinalizerString(ctx context.Context, obj Object, finalizerString string) 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 HasOtherFinalizerFn func(ctx context.Context, obj Object) (bool, error) AddFinalizerStringFn func(ctx context.Context, obj Object, finalizerString string) error RemoveFinalizerStringFn func(ctx context.Context, obj Object, finalizerString string) 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) AddFinalizerString ¶
func (f FinalizerFns) AddFinalizerString(ctx context.Context, obj Object, finalizerString string) error
AddFinalizer to the supplied resource.
func (FinalizerFns) HasOtherFinalizer ¶
RemoveFinalizer from the supplied resource.
func (FinalizerFns) RemoveFinalizer ¶
func (f FinalizerFns) RemoveFinalizer(ctx context.Context, obj Object) error
RemoveFinalizer from the supplied resource.
func (FinalizerFns) RemoveFinalizerString ¶
func (f FinalizerFns) RemoveFinalizerString(ctx context.Context, obj Object, finalizerString string) error
RemoveFinalizer from the supplied resource.
type Generation ¶
type Generation interface {
GetOwnerGeneration() string
}
type PredicateFn ¶
A PredicateFn returns true if the supplied object should be reconciled.
type Transaction ¶
type Transaction interface { Object Conditioned DeviceConditioned Generation }
A Managed is a Kubernetes object representing a concrete managed resource (e.g. a CloudSQL instance).
type TransactionKind ¶
type TransactionKind schema.GroupVersionKind
A ManagedKind contains the type metadata for a kind of managed resource.
type TransactionList ¶
type TransactionList interface { client.ObjectList // GetItems returns the list of managed resources. GetItems() []Transaction }
A ManagedList is a list of managed resources.