Documentation
¶
Overview ¶
Package predicate defines Predicates used by Controllers to filter Events before they are provided to EventHandlers.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnnotationChangedPredicate ¶ added in v0.7.0
type AnnotationChangedPredicate = TypedAnnotationChangedPredicate[client.Object]
AnnotationChangedPredicate implements a default update predicate function on annotation change.
This predicate will skip update events that have no change in the object's annotation. It is intended to be used in conjunction with the GenerationChangedPredicate, as in the following example:
Controller.Watch(
&source.Kind{Type: v1.MyCustomKind},
&handler.EnqueueRequestForObject{},
predicate.Or(predicate.GenerationChangedPredicate{}, predicate.AnnotationChangedPredicate{}))
This is mostly useful for controllers that needs to trigger both when the resource's generation is incremented (i.e., when the resource' .spec changes), or an annotation changes (e.g., for a staging/alpha API).
type Funcs ¶
type Funcs = TypedFuncs[client.Object]
Funcs is a function that implements Predicate.
Example ¶
This example creates a new Predicate to drop Update Events where the Generation has not changed.
package main
import (
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/predicate"
)
var p predicate.Predicate
// This example creates a new Predicate to drop Update Events where the Generation has not changed.
func main() {
p = predicate.Funcs{
UpdateFunc: func(e event.UpdateEvent) bool {
return e.ObjectOld.GetGeneration() != e.ObjectNew.GetGeneration()
},
}
}
Output:
type GenerationChangedPredicate ¶ added in v0.2.0
type GenerationChangedPredicate = TypedGenerationChangedPredicate[client.Object]
GenerationChangedPredicate implements a default update predicate function on Generation change.
This predicate will skip update events that have no change in the object's metadata.generation field. The metadata.generation field of an object is incremented by the API server when writes are made to the spec field of an object. This allows a controller to ignore update events where the spec is unchanged, and only the metadata and/or status fields are changed.
For CustomResource objects the Generation is only incremented when the status subresource is enabled.
Caveats:
* The assumption that the Generation is incremented only on writing to the spec does not hold for all APIs. E.g For Deployment objects the Generation is also incremented on writes to the metadata.annotations field. For object types other than CustomResources be sure to verify which fields will trigger a Generation increment when they are written to.
* With this predicate, any update events with writes only to the status field will not be reconciled. So in the event that the status block is overwritten or wiped by someone else the controller will not self-correct to restore the correct status.
type LabelChangedPredicate ¶ added in v0.8.0
type LabelChangedPredicate = TypedLabelChangedPredicate[client.Object]
LabelChangedPredicate implements a default update predicate function on label change.
This predicate will skip update events that have no change in the object's label. It is intended to be used in conjunction with the GenerationChangedPredicate, as in the following example:
Controller.Watch(
&source.Kind{Type: v1.MyCustomKind},
&handler.EnqueueRequestForObject{},
predicate.Or(predicate.GenerationChangedPredicate{}, predicate.LabelChangedPredicate{}))
This will be helpful when object's labels is carrying some extra specification information beyond object's spec, and the controller will be triggered if any valid spec change (not only in spec, but also in labels) happens.
type Predicate ¶
type Predicate = TypedPredicate[client.Object]
Predicate filters events before enqueuing the keys.
func LabelSelectorPredicate ¶ added in v0.7.0
func LabelSelectorPredicate(s metav1.LabelSelector) (Predicate, error)
LabelSelectorPredicate constructs a Predicate from a LabelSelector. Only objects matching the LabelSelector will be admitted.
type ResourceVersionChangedPredicate ¶
type ResourceVersionChangedPredicate struct {
Funcs
}
ResourceVersionChangedPredicate implements a default update predicate function on resource version change.
func (ResourceVersionChangedPredicate) Update ¶
func (ResourceVersionChangedPredicate) Update(e event.UpdateEvent) bool
Update implements default UpdateEvent filter for validating resource version change.
type TypedAnnotationChangedPredicate ¶ added in v0.18.0
type TypedAnnotationChangedPredicate[T metav1.Object] struct { TypedFuncs[T] }
TypedAnnotationChangedPredicate implements a default update predicate function on annotation change.
func (TypedAnnotationChangedPredicate[T]) Update ¶ added in v0.18.0
func (TypedAnnotationChangedPredicate[T]) Update(e event.TypedUpdateEvent[T]) bool
Update implements default UpdateEvent filter for validating annotation change.
type TypedFuncs ¶ added in v0.18.0
type TypedFuncs[T any] struct { // Create returns true if the Create event should be processed CreateFunc func(event.TypedCreateEvent[T]) bool // Delete returns true if the Delete event should be processed DeleteFunc func(event.TypedDeleteEvent[T]) bool // Update returns true if the Update event should be processed UpdateFunc func(event.TypedUpdateEvent[T]) bool // Generic returns true if the Generic event should be processed GenericFunc func(event.TypedGenericEvent[T]) bool }
TypedFuncs is a function that implements TypedPredicate.
func NewTypedPredicateFuncs ¶ added in v0.18.0
func NewTypedPredicateFuncs[T any](filter func(object T) bool) TypedFuncs[T]
NewTypedPredicateFuncs returns a predicate funcs that applies the given filter function on CREATE, UPDATE, DELETE and GENERIC events. For UPDATE events, the filter is applied to the new object.
func (TypedFuncs[T]) Create ¶ added in v0.18.0
func (p TypedFuncs[T]) Create(e event.TypedCreateEvent[T]) bool
Create implements Predicate.
func (TypedFuncs[T]) Delete ¶ added in v0.18.0
func (p TypedFuncs[T]) Delete(e event.TypedDeleteEvent[T]) bool
Delete implements Predicate.
func (TypedFuncs[T]) Generic ¶ added in v0.18.0
func (p TypedFuncs[T]) Generic(e event.TypedGenericEvent[T]) bool
Generic implements Predicate.
func (TypedFuncs[T]) Update ¶ added in v0.18.0
func (p TypedFuncs[T]) Update(e event.TypedUpdateEvent[T]) bool
Update implements Predicate.
type TypedGenerationChangedPredicate ¶ added in v0.18.0
type TypedGenerationChangedPredicate[T metav1.Object] struct { TypedFuncs[T] }
TypedGenerationChangedPredicate implements a default update predicate function on Generation change.
This predicate will skip update events that have no change in the object's metadata.generation field. The metadata.generation field of an object is incremented by the API server when writes are made to the spec field of an object. This allows a controller to ignore update events where the spec is unchanged, and only the metadata and/or status fields are changed.
For CustomResource objects the Generation is only incremented when the status subresource is enabled.
Caveats:
* The assumption that the Generation is incremented only on writing to the spec does not hold for all APIs. E.g For Deployment objects the Generation is also incremented on writes to the metadata.annotations field. For object types other than CustomResources be sure to verify which fields will trigger a Generation increment when they are written to.
* With this predicate, any update events with writes only to the status field will not be reconciled. So in the event that the status block is overwritten or wiped by someone else the controller will not self-correct to restore the correct status.
func (TypedGenerationChangedPredicate[T]) Update ¶ added in v0.18.0
func (TypedGenerationChangedPredicate[T]) Update(e event.TypedUpdateEvent[T]) bool
Update implements default UpdateEvent filter for validating generation change.
type TypedLabelChangedPredicate ¶ added in v0.18.0
type TypedLabelChangedPredicate[T metav1.Object] struct { TypedFuncs[T] }
TypedLabelChangedPredicate implements a default update predicate function on label change.
func (TypedLabelChangedPredicate[T]) Update ¶ added in v0.18.0
func (TypedLabelChangedPredicate[T]) Update(e event.TypedUpdateEvent[T]) bool
Update implements default UpdateEvent filter for checking label change.
type TypedPredicate ¶ added in v0.18.0
type TypedPredicate[T any] interface { // Create returns true if the Create event should be processed Create(event.TypedCreateEvent[T]) bool // Delete returns true if the Delete event should be processed Delete(event.TypedDeleteEvent[T]) bool // Update returns true if the Update event should be processed Update(event.TypedUpdateEvent[T]) bool // Generic returns true if the Generic event should be processed Generic(event.TypedGenericEvent[T]) bool }
TypedPredicate filters events before enqueuing the keys.
func And ¶ added in v0.5.9
func And[T any](predicates ...TypedPredicate[T]) TypedPredicate[T]
And returns a composite predicate that implements a logical AND of the predicates passed to it.
func Not ¶ added in v0.14.0
func Not[T any](predicate TypedPredicate[T]) TypedPredicate[T]
Not returns a predicate that implements a logical NOT of the predicate passed to it.
func Or ¶ added in v0.5.9
func Or[T any](predicates ...TypedPredicate[T]) TypedPredicate[T]
Or returns a composite predicate that implements a logical OR of the predicates passed to it.
Source Files