meta

Documentation

Overview

Package meta contains functions for dealing with Kubernetes object metadata.

Index

• func AddAnnotations(o metav1.Object, annotations map[string]string)
• func AddControllerReference(o metav1.Object, r metav1.OwnerReference) error
• func AddFinalizer(o metav1.Object, finalizer string)
• func AddLabels(o metav1.Object, labels map[string]string)
• func AddOwnerReference(o metav1.Object, r metav1.OwnerReference)
• func AsController(r *corev1.ObjectReference) metav1.OwnerReference
• func AsOwner(r *corev1.ObjectReference) metav1.OwnerReference
• func HaveSameController(a, b metav1.Object) bool
• func NamespacedNameOf(r *corev1.ObjectReference) types.NamespacedName
• func ReferenceTo(o metav1.Object, of schema.GroupVersionKind) *corev1.ObjectReference
• func RemoveAnnotations(o metav1.Object, annotations ...string)
• func RemoveFinalizer(o metav1.Object, finalizer string)
• func RemoveLabels(o metav1.Object, labels ...string)
• func WasCreated(o metav1.Object) bool
• func WasDeleted(o metav1.Object) bool

Functions

func AddAnnotations

func AddAnnotations(o metav1.Object, annotations map[string]string)

AddAnnotations to the supplied object.

func AddControllerReference

func AddControllerReference(o metav1.Object, r metav1.OwnerReference) error

AddControllerReference to the supplied object's metadata. Any existing owner with the same UID as the supplied reference will be replaced. Returns an error if the supplied object is already controlled by a different owner.

func AddFinalizer

func AddFinalizer(o metav1.Object, finalizer string)

AddFinalizer to the supplied Kubernetes object's metadata.

func AddLabels

func AddLabels(o metav1.Object, labels map[string]string)

AddLabels to the supplied object.

func AddOwnerReference

func AddOwnerReference(o metav1.Object, r metav1.OwnerReference)

AddOwnerReference to the supplied object' metadata. Any existing owner with the same UID as the supplied reference will be replaced.

func AsController

func AsController(r *corev1.ObjectReference) metav1.OwnerReference

AsController converts the supplied object reference to a controller reference. You may also consider using metav1.NewControllerRef.

func AsOwner

func AsOwner(r *corev1.ObjectReference) metav1.OwnerReference

AsOwner converts the supplied object reference to an owner reference.

func HaveSameController

func HaveSameController(a, b metav1.Object) bool

HaveSameController returns true if both supplied objects are controlled by the same object.

func NamespacedNameOf

func NamespacedNameOf(r *corev1.ObjectReference) types.NamespacedName

NamespacedNameOf returns the referenced object's namespaced name.

func ReferenceTo

func ReferenceTo(o metav1.Object, of schema.GroupVersionKind) *corev1.ObjectReference

ReferenceTo returns an object reference to the supplied object, presumed to be of the supplied group, version, and kind.

func RemoveAnnotations

func RemoveAnnotations(o metav1.Object, annotations ...string)

RemoveAnnotations with the supplied keys from the supplied object.

func RemoveFinalizer

func RemoveFinalizer(o metav1.Object, finalizer string)

RemoveFinalizer from the supplied Kubernetes object's metadata.

func RemoveLabels

func RemoveLabels(o metav1.Object, labels ...string)

RemoveLabels with the supplied keys from the supplied object.

func WasCreated

func WasCreated(o metav1.Object) bool

WasCreated returns true if the supplied object was created in the API server.

func WasDeleted

func WasDeleted(o metav1.Object) bool

WasDeleted returns true if the supplied object was deleted from the API server.