annotations

Documentation

Overview

Package annotations implements annotation helper functions.

Index

• func AddAnnotations(o metav1.Object, desired map[string]string) bool
• func Get(obj metav1.Object, name string) (value string, found bool)
• func Has(obj metav1.Object, name string) bool
• func HasSkipRemediation(o metav1.Object) bool
• func HasWithPrefix(prefix string, annotations map[string]string) bool
• func IsPaused(obj metav1.Object) bool
• func Set(obj metav1.Object, name, value string)

Functions

func AddAnnotations

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

AddAnnotations sets the desired annotations on the object and returns true if the annotations have changed.

func Get

func Get(obj metav1.Object, name string) (value string, found bool)

Get will get the value of the supplied annotation.

func Has

func Has(obj metav1.Object, name string) bool

Has returns true if the supplied object has the supplied annotation.

func HasSkipRemediation

func HasSkipRemediation(o metav1.Object) bool

HasSkipRemediation returns true if the object has the `skip-remediation` annotation.

func HasWithPrefix

func HasWithPrefix(prefix string, annotations map[string]string) bool

HasWithPrefix returns true if at least one of the annotations has the prefix specified.

func IsPaused

func IsPaused(obj metav1.Object) bool

IsPaused returns true if the object has the `paused` annotation.

func Set

func Set(obj metav1.Object, name, value string)

Set will set the value of an annotation on the supplied object. If there is no annotation it will be created.