event

Documentation

Index

• Constants
• func NewEventGenerator(eventsClient v1.EventsV1Interface, logger logr.Logger, omitEvents ...string) *controller
• type Action
• type Info
  • func NewBackgroundFailedEvent(err error, policy kyvernov1.PolicyInterface, rule string, source Source, ...) []Info
  • func NewBackgroundSuccessEvent(source Source, policy kyvernov1.PolicyInterface, ...) []Info
  • func NewCleanupPolicyEvent(policy kyvernov2alpha1.CleanupPolicyInterface, ...) 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 NewResourceGenerationEvent(policy, rule string, source Source, resource kyvernov1.ResourceSpec) Info
  • func NewResourceViolationEvent(source Source, reason Reason, engineResponse engineapi.EngineResponse, ...) Info
  • func NewValidatingAdmissionPolicyEvent(policy kyvernov1.PolicyInterface, vapName, vapBindingName string) []Info
  • func (i *Info) Resource() string
• type Interface
  • func NewFake() Interface
• type Reason
• type Source

Constants

const (
	Workers        = 3
	ControllerName = "kyverno-events"
)

Functions

func NewEventGenerator

func NewEventGenerator(eventsClient v1.EventsV1Interface, logger logr.Logger, omitEvents ...string) *controller

NewEventGenerator to generate a new event controller

Types

type Action

type Action string

Action types of Event Actions

const (
	ResourceBlocked   Action = "Resource Blocked"
	ResourcePassed    Action = "Resource Passed"
	ResourceGenerated Action = "Resource Generated"
	ResourceMutated   Action = "Resource Mutated"
	ResourceCleanedUp Action = "Resource Cleaned Up"
	None              Action = "None"
)

type Info

type Info struct {
	Regarding corev1.ObjectReference
	Related   *corev1.ObjectReference
	Reason    Reason
	Message   string
	Action    Action
	Source    Source
}

Info defines the event details

func NewBackgroundFailedEvent

func NewBackgroundFailedEvent(err error, policy kyvernov1.PolicyInterface, rule string, source Source, resource kyvernov1.ResourceSpec) []Info

func NewBackgroundSuccessEvent

func NewBackgroundSuccessEvent(source Source, policy kyvernov1.PolicyInterface, resources []kyvernov1.ResourceSpec) []Info

func NewCleanupPolicyEvent

func NewCleanupPolicyEvent(policy kyvernov2alpha1.CleanupPolicyInterface, resource unstructured.Unstructured, err error) 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 NewResourceGenerationEvent

func NewResourceGenerationEvent(policy, rule string, source Source, resource kyvernov1.ResourceSpec) Info

func NewResourceViolationEvent

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

func NewValidatingAdmissionPolicyEvent

func NewValidatingAdmissionPolicyEvent(policy kyvernov1.PolicyInterface, vapName, vapBindingName string) []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"
)