event

Documentation

Index

• type Generator
  • func NewEventGenerator(client dclient.Interface, cpInformer kyvernov1informers.ClusterPolicyInformer, ...) *Generator
  • func (gen *Generator) Add(infos ...Info)
  • func (gen *Generator) Run(ctx context.Context, workers int)
• type Info
  • func NewBackgroundFailedEvent(err error, policy, rule string, source Source, r *unstructured.Unstructured) []Info
  • func NewBackgroundSuccessEvent(policy, rule string, source Source, r *unstructured.Unstructured) []Info
  • func NewPolicyAppliedEvent(source Source, engineResponse *response.EngineResponse) Info
  • func NewPolicyFailEvent(source Source, reason Reason, engineResponse *response.EngineResponse, ...) Info
  • func NewResourceViolationEvent(source Source, reason Reason, engineResponse *response.EngineResponse, ...) Info
• type Interface
  • func NewFake() Interface
• type Reason
  • func (r Reason) String() string
• type Source
  • func (s Source) String() string

Types

type Generator

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

Generator generate events

func NewEventGenerator

func NewEventGenerator(client dclient.Interface, cpInformer kyvernov1informers.ClusterPolicyInformer, pInformer kyvernov1informers.PolicyInformer, maxQueuedEvents int, 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(ctx context.Context, workers int)

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 NewBackgroundFailedEvent

func NewBackgroundFailedEvent(err error, policy, rule string, source Source, r *unstructured.Unstructured) []Info

func NewBackgroundSuccessEvent

func NewBackgroundSuccessEvent(policy, rule string, source Source, r *unstructured.Unstructured) []Info

func NewPolicyAppliedEvent

func NewPolicyAppliedEvent(source Source, engineResponse *response.EngineResponse) Info

func NewPolicyFailEvent

func NewPolicyFailEvent(source Source, reason Reason, engineResponse *response.EngineResponse, ruleResp *response.RuleResponse, blocked bool) Info

func NewResourceViolationEvent

func NewResourceViolationEvent(source Source, reason Reason, engineResponse *response.EngineResponse, ruleResp *response.RuleResponse) Info

type Interface

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

Interface to generate event

func NewFake

func NewFake() Interface

type Reason

type Reason int

Reason types of Event Reasons

const (
	PolicyViolation Reason = iota
	PolicyApplied
	PolicyError
	PolicySkipped
)

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
	// MutateExistingController : event generated for mutateExisting policies
	MutateExistingController
)

func (Source) String

func (s Source) String() string