multiowner

Documentation

Overview

Package multiowner implements helpers to work with objects that have multiple owners. Similar to our owner package it works across cluster and namespace boundaries.

Index

• Constants
• func AddOwnerReverseFieldIndex(indexer client.FieldIndexer, log logr.Logger, object runtime.Object) error
• func DeleteOwnerReference(owner, object object, scheme *runtime.Scheme) (changed bool, err error)
• func EnqueueRequestForOwner(ownerType object, scheme *runtime.Scheme) handler.EventHandler
• func InsertOwnerReference(owner, object object, scheme *runtime.Scheme) (changed bool, err error)
• func IsOwned(object metav1.Object) (owned bool, err error)
• func OwnedBy(owner object, sc *runtime.Scheme) generalizedListOption

Constants

const (
	// OwnerAnnotation is the annotation key that references the owner of this object.
	OwnerAnnotation = "kubecarrier.io/owner"
)

Functions

func AddOwnerReverseFieldIndex

func AddOwnerReverseFieldIndex(indexer client.FieldIndexer, log logr.Logger, object runtime.Object) error

AddOwnerReverseFieldIndex adds a reverse index for OwnerReferences.

The created index allows listing all owned objects of a given type by the owner object. Keep in mind this function should be called for each owned object type separately.

See also: OwnedBy

func DeleteOwnerReference

func DeleteOwnerReference(owner, object object, scheme *runtime.Scheme) (changed bool, err error)

DeleteOwnerReference removes an owner from the given object.

func EnqueueRequestForOwner

func EnqueueRequestForOwner(ownerType object, scheme *runtime.Scheme) handler.EventHandler

EnqueueRequestForOwner enqueues requests for all owners of an object.

It implements the same behavior as handler.EnqueueRequestForOwner, but for our custom objectReference.

func InsertOwnerReference

func InsertOwnerReference(owner, object object, scheme *runtime.Scheme) (changed bool, err error)

InsertOwnerReference adds an OwnerReference to the given object.

func IsOwned

func IsOwned(object metav1.Object) (owned bool, err error)

IsOwned checks if any owners claim ownership of this object.

func OwnedBy

func OwnedBy(owner object, sc *runtime.Scheme) generalizedListOption

OwnedBy returns owner filter for listing objects.

See also: AddOwnerReverseFieldIndex