ctrlutils

Documentation

Index

• Constants
• func CleanupFinalizer(ctx context.Context, c client.Client, log logr.Logger, ...) (ctrl.Result, error)
• func GeneratePredicateFuncsForIngressClassFilter(name string, specCheckEnabled, annotationCheckEnabled bool) predicate.Funcs
• func HasAnnotation(obj client.Object, key, expectedValue string) bool
• func HasFinalizer(obj client.Object, finalizer string) bool
• func IsIngressClassAnnotationConfigured(obj client.Object, expectedIngressClassName string) bool
• func IsIngressClassSpecConfigured(obj client.Object, expectedIngressClassName string) bool
• func MatchesIngressClassName(obj client.Object, ingressClassName string) bool

Constants

const KongIngressFinalizer = "configuration.konghq.com/ingress"

KongIngressFinalizer is the finalizer used to ensure Kong configuration cleanup for deleted resources.

Functions

func CleanupFinalizer

func CleanupFinalizer(ctx context.Context, c client.Client, log logr.Logger, nsn types.NamespacedName, obj client.Object) (ctrl.Result, error)

CleanupFinalizer ensures that a deleted resource is no longer present in the object cache.

func GeneratePredicateFuncsForIngressClassFilter

func GeneratePredicateFuncsForIngressClassFilter(name string, specCheckEnabled, annotationCheckEnabled bool) predicate.Funcs

GeneratePredicateFuncsForIngressClassFilter builds a controller-runtime reconcilation predicate function which filters out objects which do not have the "kubernetes.io/ingress.class" annotation configured and set to the provided value or in their .spec.

func HasAnnotation

func HasAnnotation(obj client.Object, key, expectedValue string) bool

HasAnnotation is a helper function to determine whether an object has a given annotation, and whether it's to the value provided.

func HasFinalizer

func HasFinalizer(obj client.Object, finalizer string) bool

HasFinalizer is a helper function to check whether a client.Object already has a specific finalizer set.

func IsIngressClassAnnotationConfigured

func IsIngressClassAnnotationConfigured(obj client.Object, expectedIngressClassName string) bool

IsIngressClassAnnotationConfigured determines whether an object has an ingress.class annotation configured that matches the provide IngressClassName (and is therefore an object configured to be reconciled by that class).

NOTE: keep in mind that the ingress.class annotation is deprecated and will be removed in a future release

of Kubernetes in favor of the .spec based implementation.

func IsIngressClassSpecConfigured

func IsIngressClassSpecConfigured(obj client.Object, expectedIngressClassName string) bool

IsIngressClassAnnotationConfigured determines whether an object has IngressClassName field in its spec and whether the value matches the provide IngressClassName (and is therefore an object configured to be reconciled by that class).

func MatchesIngressClassName

func MatchesIngressClassName(obj client.Object, ingressClassName string) bool

MatchesIngressClassName indicates whether or not an object indicates that it's supported by the ingress class name provided.