events

Documentation

Index

• Constants
• func NewContext(ctx context.Context, rec OwnerEventRecorder) context.Context
• type OwnerEventRecorder
  • func FromContextOrDie(ctx context.Context) OwnerEventRecorder
  • func FromEventRecorder(rec record.EventRecorder, ownerObj runtime.Object, mapper meta.RESTMapper, ...) OwnerEventRecorder

Constants

const NormalType = "Normal"

const QualifiedResourceNameToken = "%Q"

const ResourceHealthyStatusChangedReason = "ResourceHealthyStatusChanged"

const ResourceOutputChangedReason = "ResourceOutputChanged"

const StampedObjectAppliedReason = "StampedObjectApplied"

const StampedObjectRemovedReason = "StampedObjectRemoved"

Functions

func NewContext

func NewContext(ctx context.Context, rec OwnerEventRecorder) context.Context

NewContext returns a new Context, derived from ctx, which carries the provided OwnerEventRecorder.

Types

type OwnerEventRecorder

type OwnerEventRecorder interface {
	// Event uses an EventRecorder to record an event against this OwnerEventRecorder's owner object
	Event(eventtype, reason, message string)

	// Eventf is just like Event, but with Sprintf for the message field.
	Eventf(eventtype, reason, messageFmt string, args ...interface{})

	// AnnotatedEventf is just like eventf, but with annotations attached
	AnnotatedEventf(annotations map[string]string, eventtype, reason, messageFmt string, args ...interface{})

	// ResourceEventf is just like Eventf, but the token %Q will be substituted with the qualified name of the provided unstructured resource
	ResourceEventf(eventtype, reason, messageFmt string, resource *unstructured.Unstructured, args ...interface{})
}

func FromContextOrDie

func FromContextOrDie(ctx context.Context) OwnerEventRecorder

FromContextOrDie returns a OwnerEventRecorder from ctx. If no OwnerEventRecorder is found, this panics

func FromEventRecorder

func FromEventRecorder(rec record.EventRecorder, ownerObj runtime.Object, mapper meta.RESTMapper, log logr.Logger) OwnerEventRecorder