utils

Documentation

Index

• Constants
• Variables
• func CalculateExponentialBackoffWithJitter(retryCount int64) time.Duration
• func CurrentNamespace() string
• func DebouncedReconcileCheck(ctx context.Context, lastProcessedItems *sync.Map, name types.NamespacedName) (runNow bool, alreadyQueued bool, waitTime time.Duration)
• func EscapeJSONPointer(s string) string
• func FindRootOwnerReference(ctx context.Context, c client.Client, namespace string, obj metav1.Object) (*metav1.OwnerReference, error)
• func GetObjectHash(objs ...any) string
• func HandleFinalizer[T client.Object](ctx context.Context, obj T, r client.Client, ...) (shouldReturn bool, err error)
• func IsPodConditionTrue(conditions []corev1.PodCondition, conditionType corev1.PodConditionType) bool
• func IsPodTerminated(pod *corev1.Pod) bool

Constants

const DebounceKeySuffix = ":in_queue"

Variables

var ErrNextLoop = errors.New("stop this loop and return the associated Result object")

ErrNextLoop is not a real error. It forces the current reconciliation loop to stop and return the associated Result object

var ErrTerminateLoop = errors.New("stop this loop and do not requeue")

ErrTerminateLoop is not a real error. It forces the current reconciliation loop to stop

Functions

func CalculateExponentialBackoffWithJitter

func CalculateExponentialBackoffWithJitter(retryCount int64) time.Duration

func CurrentNamespace

func CurrentNamespace() string

func DebouncedReconcileCheck

func DebouncedReconcileCheck(ctx context.Context, lastProcessedItems *sync.Map, name types.NamespacedName) (runNow bool, alreadyQueued bool, waitTime time.Duration)

func EscapeJSONPointer

func EscapeJSONPointer(s string) string

EscapeJSONPointer escapes a string according to the JSON Pointer spec (RFC 6901). It escapes '~' as '~0' and '/' as '~1'.

func FindRootOwnerReference

func FindRootOwnerReference(ctx context.Context, c client.Client, namespace string, obj metav1.Object) (*metav1.OwnerReference, error)

FindRootOwnerReference recursively finds the root owner reference for a given object (e.g. Pod).

func GetObjectHash

func GetObjectHash(objs ...any) string

GetObjectHash generates a shorter FNV-1a hash for one or more objects

func HandleFinalizer

func HandleFinalizer[T client.Object](
	ctx context.Context,
	obj T,
	r client.Client,
	deleteHook func(context.Context, T) (bool, error),
) (shouldReturn bool, err error)

HandleFinalizer ensures proper finalizer management for Kubernetes resources. It automatically adds the finalizer when needed, and removes it after successful cleanup. Returns (shouldReturn, err):

• shouldReturn: true if the caller should immediately return and wait for the next reconcile.
• err: any error encountered during update or deleteHook.

func IsPodConditionTrue

func IsPodConditionTrue(conditions []corev1.PodCondition, conditionType corev1.PodConditionType) bool

func IsPodTerminated

func IsPodTerminated(pod *corev1.Pod) bool