event

Documentation

Index

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

Types

type Generator

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

Generator generate events

func NewEventGenerator

func NewEventGenerator(client *client.Client,
	pInformer kyvernoinformer.ClusterPolicyInformer) *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
}

Info defines the event details

func NewEvent

func NewEvent(rkind string, rnamespace string, rname string, reason Reason, message MsgKey, args ...interface{}) *Info

TODO: check if we need this ? NewEvent returns a new event

func NewEventNew

func NewEventNew(
	rkind,
	rapiVersion,
	rnamespace,
	rname,
	reason string,
	message MsgKey,
	args ...interface{}) Info

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

const (
	FResourcePolcy MsgKey = iota
	FProcessRule
	SPolicyApply
	SRulesApply
	FPolicyApplyBlockCreate
	FPolicyApplyBlockUpdate
	FPolicyBlockResourceUpdate
)

Message id for pre-defined messages

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
	//RequestBlocked the request to create/update the resource was blocked( generated from admission-controller)
	RequestBlocked
)

func (Reason) String

func (r Reason) String() string