event

Documentation

Index

• func NewRecorder(source Source, sink typedcorev1.EventInterface) record.EventRecorder
• type Controller
  • func NewEventGenerator(client dclient.Interface, cpInformer kyvernov1informers.ClusterPolicyInformer, ...) Controller
• 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 NewFailedEvent(err error, policy, rule string, source Source, resource kyvernov1.ResourceSpec) Info
  • func NewPolicyAppliedEvent(source Source, engineResponse engineapi.EngineResponse) Info
  • func NewPolicyExceptionEvents(engineResponse engineapi.EngineResponse, ruleResp engineapi.RuleResponse, ...) []Info
  • func NewPolicyFailEvent(source Source, reason Reason, engineResponse engineapi.EngineResponse, ...) Info
  • func NewResourceViolationEvent(source Source, reason Reason, engineResponse engineapi.EngineResponse, ...) Info
  • func (i *Info) Resource() string
• type Interface
  • func NewFake() Interface
• type Reason
• type Source

Functions

func NewRecorder

func NewRecorder(source Source, sink typedcorev1.EventInterface) record.EventRecorder

Types

type Controller

type Controller interface {
	Interface
	Run(context.Context, int, *sync.WaitGroup)
}

Controller interface to generate event

func NewEventGenerator

func NewEventGenerator(

	client dclient.Interface,
	cpInformer kyvernov1informers.ClusterPolicyInformer,
	pInformer kyvernov1informers.PolicyInformer,
	maxQueuedEvents int,
	omitEvents []string,
	log logr.Logger,
) Controller

NewEventGenerator to generate a new event controller

type Info

type Info struct {
	Kind      string
	Name      string
	Namespace string
	Reason    Reason
	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 NewFailedEvent

func NewFailedEvent(err error, policy, rule string, source Source, resource kyvernov1.ResourceSpec) Info

func NewPolicyAppliedEvent

func NewPolicyAppliedEvent(source Source, engineResponse engineapi.EngineResponse) Info

func NewPolicyExceptionEvents

func NewPolicyExceptionEvents(engineResponse engineapi.EngineResponse, ruleResp engineapi.RuleResponse, source Source) []Info

func NewPolicyFailEvent

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

func NewResourceViolationEvent

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

func (*Info) Resource

func (i *Info) Resource() string

type Interface

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

Interface to generate event

func NewFake

func NewFake() Interface

type Reason

type Reason string

Reason types of Event Reasons

const (
	PolicyViolation Reason = "PolicyViolation"
	PolicyApplied   Reason = "PolicyApplied"
	PolicyError     Reason = "PolicyError"
	PolicySkipped   Reason = "PolicySkipped"
)

type Source

type Source string

Source of event generation

const (
	// AdmissionController : event generated in admission-control webhook
	AdmissionController Source = "kyverno-admission"
	// PolicyController : event generated in policy-controller
	PolicyController Source = "kyverno-scan"
	// GeneratePolicyController : event generated in generate policyController
	GeneratePolicyController Source = "kyverno-generate"
	// MutateExistingController : event generated for mutateExisting policies
	MutateExistingController Source = "kyverno-mutate"
	// CleanupController : event generated for cleanup policies
	CleanupController Source = "kyverno-cleanup"
)