eventer

Documentation

Index

• Constants
• type Option
  • func WithClient(c kubernetes.Interface) Option
  • func WithComponent(c string) Option
  • func WithLogger(l *zap.Logger) Option
  • func WithNamespace(ns string) Option
• type Poster
  • func NewEventRecorder(eventerOpts ...Option) (Poster, error)
  • func NewNopPoster() Poster

Constants

const (

	// Add events
	ReasonAdding        = "Adding"
	ReasonFailedToAdd   = "FailedToAdd"
	ReasonSuccessfulAdd = "SuccessfulAdd"

	// Delete events
	ReasonDeleting         = "Deleting"
	ReasonFailedToDelete   = "FailedToDelete"
	ReasonSuccessfulDelete = "SuccessfulDelete"

	// Create events
	ReasonCreating         = "Creating"
	ReasonFailedCreate     = "FailedToCreate"
	ReasonSuccessfulCreate = "SuccessfulCreate"

	// Update events
	ReasonUpdating         = "Updating"
	ReasonFailedToUpdate   = "FailedToUpdate"
	ReasonSuccessfulUpdate = "SuccessfulUpdate"

	// Sync events
	ReasonSyncing     = "Syncing"
	ReasonFailSync    = "FailedToSync"
	ReasonSuccessSync = "SuccessfulSync"

	// Misc events
	ReasonLongerThanUsual = "TimeLongerThanUsual"
	ReasonUnknown         = "Unknown"
)

Types of kubernetes emitted events

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option provides configuration of an eventer.

func WithClient

func WithClient(c kubernetes.Interface) Option

WithClient sets a client for the eventer (required).

func WithComponent

func WithComponent(c string) Option

WithComponent sets a component for the eventer.

func WithLogger

func WithLogger(l *zap.Logger) Option

WithLogger sets a logger for the eventer. If not set a noop logger will be used.

func WithNamespace

func WithNamespace(ns string) Option

WithNamespace sets a namespace for the eventer.

type Poster

type Poster interface {
	NormalEvent(object runtime.Object, reason, message string, args ...interface{})
	WarningEvent(object runtime.Object, reason, message string, args ...interface{})
}

Poster posts events accordingly to kind of behavior

func NewEventRecorder

func NewEventRecorder(eventerOpts ...Option) (Poster, error)

NewEventRecorder creates a new recorder to emit kubernetes events.

func NewNopPoster

func NewNopPoster() Poster

NewNopPoster returns an Poster that does nothing.