event

Documentation

Index

• Constants
• type Generator
  • func NewEventGenerator(client *client.Client, cpInformer kyvernoinformer.ClusterPolicyInformer, ...) *Generator
  • func (gen *Generator) Add(infos ...Info)
  • func (gen *Generator) Run(workers int, stopCh <-chan struct{})
• type Info
  • func NewEvent(log logr.Logger, rkind, rapiVersion, rnamespace, rname, reason string, ...) Info
• type Interface
• type MsgKey
  • func (k MsgKey) String() string
• type Reason
  • func (r Reason) String() string
• type Source
  • func (s Source) String() string

Constants

const (
	FPolicyApply = iota
	FResourcePolicyApply
	SPolicyApply
)

Message id for pre-defined messages

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator generate events

func NewEventGenerator

func NewEventGenerator(client *client.Client, cpInformer kyvernoinformer.ClusterPolicyInformer, pInformer kyvernoinformer.PolicyInformer, resCache resourcecache.ResourceCache, log logr.Logger) *Generator

NewEventGenerator to generate a new event controller

func (*Generator) Add

func (gen *Generator) Add(infos ...Info)

Add queues an event for generation

func (*Generator) Run

func (gen *Generator) Run(workers int, stopCh <-chan struct{})

Run begins generator

type Info

type Info struct {
	Kind      string
	Name      string
	Namespace string
	Reason    string
	Message   string
	Source    Source
}

Info defines the event details

func NewEvent

func NewEvent(
	log logr.Logger,
	rkind,
	rapiVersion,
	rnamespace,
	rname,
	reason string,
	source Source,
	message MsgKey,
	args ...interface{}) Info

NewEvent builds a event creation request

type Interface

type Interface interface {
	Add(infoList ...Info)
}

Interface to generate event

type MsgKey

type MsgKey int

MsgKey is an identified to determine the preset message formats

func (MsgKey) String

func (k MsgKey) String() string

type Reason

type Reason int

Reason types of Event Reasons

const (
	//PolicyViolation there is a violation of policy
	PolicyViolation Reason = iota
	//PolicyApplied policy applied
	PolicyApplied
	//PolicyFailed policy failed
	PolicyFailed
)

func (Reason) String

func (r Reason) String() string

type Source

type Source int

Source of event generation

const (
	// AdmissionController : event generated in admission-control webhook
	AdmissionController Source = iota
	// PolicyController : event generated in policy-controller
	PolicyController
	// GeneratePolicyController : event generated in generate policyController
	GeneratePolicyController
)

func (Source) String

func (s Source) String() string