-
Notifications
You must be signed in to change notification settings - Fork 783
/
controller.go
189 lines (174 loc) · 5.83 KB
/
controller.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
package event
import (
"context"
"fmt"
"os"
"time"
"github.com/go-logr/logr"
"github.com/kyverno/kyverno/pkg/client/clientset/versioned/scheme"
"github.com/kyverno/kyverno/pkg/metrics"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/metric"
corev1 "k8s.io/api/core/v1"
eventsv1 "k8s.io/api/events/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
v1 "k8s.io/client-go/kubernetes/typed/events/v1"
"k8s.io/client-go/tools/record/util"
"k8s.io/client-go/tools/reference"
"k8s.io/client-go/util/workqueue"
"k8s.io/utils/clock"
)
const (
Workers = 3
ControllerName = "kyverno-events"
workQueueRetryLimit = 3
)
// Interface to generate event
type Interface interface {
Add(infoList ...Info)
}
// controller generate events
type controller struct {
logger logr.Logger
eventsClient v1.EventsV1Interface
omitEvents sets.Set[string]
queue workqueue.RateLimitingInterface
clock clock.Clock
hostname string
droppedEventsCounter metric.Int64Counter
}
// NewEventGenerator to generate a new event controller
func NewEventGenerator(eventsClient v1.EventsV1Interface, logger logr.Logger, omitEvents ...string) *controller {
clock := clock.RealClock{}
hostname, _ := os.Hostname()
meter := otel.GetMeterProvider().Meter(metrics.MeterName)
droppedEventsCounter, err := meter.Int64Counter(
"kyverno_events_dropped",
metric.WithDescription("can be used to track the number of events dropped by the event generator"),
)
if err != nil {
logger.Error(err, "failed to register metric kyverno_events_dropped")
}
return &controller{
logger: logger,
eventsClient: eventsClient,
omitEvents: sets.New(omitEvents...),
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), ControllerName),
clock: clock,
hostname: hostname,
droppedEventsCounter: droppedEventsCounter,
}
}
// Add queues an event for generation
func (gen *controller) Add(infos ...Info) {
logger := gen.logger
logger.V(3).Info("generating events", "count", len(infos))
for _, info := range infos {
// don't create event for resources with generateName as the name is not generated yet
if info.Regarding.Name == "" {
logger.V(3).Info("skipping event creation for resource without a name", "kind", info.Regarding.Kind, "name", info.Regarding.Name, "namespace", info.Regarding.Namespace)
continue
}
if gen.omitEvents.Has(string(info.Reason)) {
logger.V(6).Info("omitting event", "kind", info.Regarding.Kind, "name", info.Regarding.Name, "namespace", info.Regarding.Namespace, "reason", info.Reason)
continue
}
gen.emitEvent(info)
logger.V(6).Info("creating event", "kind", info.Regarding.Kind, "name", info.Regarding.Name, "namespace", info.Regarding.Namespace, "reason", info.Reason)
}
}
// Run begins generator
func (gen *controller) Run(ctx context.Context, workers int) {
logger := gen.logger
logger.Info("start")
defer logger.Info("terminated")
defer utilruntime.HandleCrash()
var waitGroup wait.Group
for i := 0; i < workers; i++ {
waitGroup.StartWithContext(ctx, func(ctx context.Context) {
for gen.processNextWorkItem(ctx) {
}
})
}
<-ctx.Done()
gen.queue.ShutDownWithDrain()
waitGroup.Wait()
}
func (gen *controller) processNextWorkItem(ctx context.Context) bool {
logger := gen.logger
key, quit := gen.queue.Get()
if quit {
return false
}
defer gen.queue.Done(key)
event, ok := key.(*eventsv1.Event)
if !ok {
logger.Error(nil, "failed to convert key to Info", "key", key)
return true
}
_, err := gen.eventsClient.Events(event.Namespace).Create(ctx, event, metav1.CreateOptions{})
if err != nil {
if gen.queue.NumRequeues(key) < workQueueRetryLimit {
logger.Error(err, "failed to create event", "key", key)
gen.queue.AddRateLimited(key)
return true
}
gen.droppedEventsCounter.Add(ctx, 1)
logger.Error(err, "dropping event", "key", key)
}
gen.queue.Forget(key)
return true
}
func (gen *controller) emitEvent(key Info) {
logger := gen.logger
eventType := corev1.EventTypeWarning
if key.Type != "" {
eventType = key.Type
} else if key.Reason == PolicyApplied || key.Reason == PolicySkipped {
eventType = corev1.EventTypeNormal
}
timestamp := metav1.MicroTime{Time: time.Now()}
refRegarding, err := reference.GetReference(scheme.Scheme, &key.Regarding)
if err != nil {
logger.Error(err, "Could not construct reference, will not report event", "object", &key.Regarding, "eventType", eventType, "reason", string(key.Reason), "message", key.Message)
return
}
var refRelated *corev1.ObjectReference
if key.Related != nil {
refRelated, err = reference.GetReference(scheme.Scheme, key.Related)
if err != nil {
logger.V(9).Info("Could not construct reference", "object", key.Related, "err", err)
}
}
if !util.ValidateEventType(eventType) {
logger.Error(nil, "Unsupported event type", "eventType", eventType)
return
}
reportingController := string(key.Source)
reportingInstance := reportingController + "-" + gen.hostname
t := metav1.Time{Time: gen.clock.Now()}
namespace := refRegarding.Namespace
if namespace == "" {
namespace = metav1.NamespaceDefault
}
event := &eventsv1.Event{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("%v.%x", refRegarding.Name, t.UnixNano()),
Namespace: namespace,
},
EventTime: timestamp,
Series: nil,
ReportingController: reportingController,
ReportingInstance: reportingInstance,
Action: string(key.Action),
Reason: string(key.Reason),
Regarding: *refRegarding,
Related: refRelated,
Note: key.Message,
Type: eventType,
}
gen.queue.Add(event)
}