annotations

Documentation

Overview

Package annotations implements annotation helper functions.

Index

• func AddAnnotations(o metav1.Object, desired map[string]string) bool
• func HasPaused(o metav1.Object) bool
• func HasPausedAnnotation(o metav1.Object) bool
• func HasSkipRemediation(o metav1.Object) bool
• func HasSkipRemediationAnnotation(o metav1.Object) bool
• func HasWithPrefix(prefix string, annotations map[string]string) bool
• func IsExternallyManaged(o metav1.Object) bool
• func IsPaused(cluster *clusterv1.Cluster, o metav1.Object) bool

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 HasPaused

func HasPaused(o metav1.Object) bool

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

func HasPausedAnnotation

func HasPausedAnnotation(o metav1.Object) bool

HasPausedAnnotation returns true if the object has the `paused` annotation. Deprecated: this is going to be removed in a next release. Please use `HasPaused` instead.

func HasSkipRemediation

func HasSkipRemediation(o metav1.Object) bool

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

func HasSkipRemediationAnnotation

func HasSkipRemediationAnnotation(o metav1.Object) bool

HasSkipRemediationAnnotation returns true if the object has the `skip-remediation` annotation. Deprecated: this is going to be removed in a next release. Please use `HasSkipRemediation` instead.

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 IsExternallyManaged

func IsExternallyManaged(o metav1.Object) bool

IsExternallyManaged returns true if the object has the `managed-by` annotation.

func IsPaused

func IsPaused(cluster *clusterv1.Cluster, o metav1.Object) bool

IsPaused returns true if the Cluster is paused or the object has the `paused` annotation.