annotation

Documentation

Index

• Constants
• func IsPatched(object metav1.Object, annotations ...Annotation) bool
• func Patch(object metav1.Object, annotations ...Annotation) ([]byte, error)
• type Annotation

Constants

const (

	// Result identifier.
	Result = "results.tekton.dev/result"

	// Record identifier.
	Record = "results.tekton.dev/record"

	// Log identifier.
	Log = "results.tekton.dev/log"

	// EventList identifier.
	EventList = "results.tekton.dev/eventlist"

	// Stored is an annotation that signals to the controller that a given object
	// has been stored by the Results API.
	Stored = "results.tekton.dev/stored"

	// ResultAnnotations is an annotation that integrators should add to objects in order to store
	// arbitrary keys/values into the Result.Annotations field.
	ResultAnnotations = "results.tekton.dev/resultAnnotations"

	// RecordSummaryAnnotations is an annotation that integrators should add to objects
	// in order to store arbitrary keys/values into the Result.Summary.Annotations field.
	// This allows for additional information to be associated with the summary of a record.
	RecordSummaryAnnotations = "results.tekton.dev/recordSummaryAnnotations"

	// ChildReadyForDeletion is an annotation that signals to the controller that a given child object
	// (e.g. TaskRun owned by a PipelineRun) is done and up to date in the
	// API server and therefore, ready to be garbage collected.
	ChildReadyForDeletion = "results.tekton.dev/childReadyForDeletion"
)

Functions

func IsPatched

func IsPatched(object metav1.Object, annotations ...Annotation) bool

IsPatched returns true if the object in question contains all relevant annotations or false otherwise.

func Patch

func Patch(object metav1.Object, annotations ...Annotation) ([]byte, error)

Patch creates a jsonpatch path used for adding result / record identifiers as well as other internal annotations to an object's annotations field.

Types

type Annotation

type Annotation struct {
	Name  string
	Value string
}

Annotation is wrapper for Kubernetes resource annotations stored in the metadata.