/
expansion_controller.go
277 lines (238 loc) Β· 8.38 KB
/
expansion_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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
package expansion
import (
"context"
"fmt"
"github.com/open-policy-agent/gatekeeper/v3/apis/expansion/unversioned"
expansionv1beta1 "github.com/open-policy-agent/gatekeeper/v3/apis/expansion/v1beta1"
statusv1beta1 "github.com/open-policy-agent/gatekeeper/v3/apis/status/v1beta1"
"github.com/open-policy-agent/gatekeeper/v3/pkg/expansion"
"github.com/open-policy-agent/gatekeeper/v3/pkg/logging"
"github.com/open-policy-agent/gatekeeper/v3/pkg/metrics"
"github.com/open-policy-agent/gatekeeper/v3/pkg/readiness"
"github.com/open-policy-agent/gatekeeper/v3/pkg/util"
"github.com/open-policy-agent/gatekeeper/v3/pkg/watch"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
var log = logf.Log.WithName("controller").WithValues("kind", "ExpansionTemplate", logging.Process, "template_expansion_controller")
// eventQueueSize is how many events to queue before blocking.
const eventQueueSize = 1024
type Adder struct {
WatchManager *watch.Manager
ExpansionSystem *expansion.System
Tracker *readiness.Tracker
// GetPod returns an instance of the currently running Gatekeeper pod
GetPod func(context.Context) (*corev1.Pod, error)
}
func (a *Adder) Add(mgr manager.Manager) error {
if !*expansion.ExpansionEnabled {
return nil
}
r := newReconciler(mgr, a.ExpansionSystem, a.GetPod, a.Tracker)
return add(mgr, r)
}
func (a *Adder) InjectControllerSwitch(_ *watch.ControllerSwitch) {}
func (a *Adder) InjectTracker(tracker *readiness.Tracker) {
a.Tracker = tracker
}
func (a *Adder) InjectExpansionSystem(expansionSystem *expansion.System) {
a.ExpansionSystem = expansionSystem
}
func (a *Adder) InjectGetPod(getPod func(ctx context.Context) (*corev1.Pod, error)) {
a.GetPod = getPod
}
type Reconciler struct {
client.Client
system *expansion.System
scheme *runtime.Scheme
registry *etRegistry
statusClient client.StatusClient
tracker *readiness.Tracker
events chan event.GenericEvent
eventSource source.Source
getPod func(context.Context) (*corev1.Pod, error)
}
func newReconciler(mgr manager.Manager,
system *expansion.System,
getPod func(ctx context.Context) (*corev1.Pod, error),
tracker *readiness.Tracker,
) *Reconciler {
ev := make(chan event.GenericEvent, eventQueueSize)
return &Reconciler{
Client: mgr.GetClient(),
system: system,
scheme: mgr.GetScheme(),
registry: newRegistry(),
statusClient: mgr.GetClient(),
getPod: getPod,
tracker: tracker,
events: ev,
eventSource: &source.Channel{Source: ev, DestBufferSize: 1024},
}
}
func add(mgr manager.Manager, r *Reconciler) error {
c, err := controller.New("expansion-template-controller", mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for enqueued events
if r.eventSource != nil {
err = c.Watch(
r.eventSource,
&handler.EnqueueRequestForObject{})
if err != nil {
return err
}
}
// Watch for changes to ExpansionTemplates
return c.Watch(
source.Kind(mgr.GetCache(), &expansionv1beta1.ExpansionTemplate{}),
&handler.EnqueueRequestForObject{})
}
func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {
defer r.registry.report(ctx)
log.V(logging.DebugLevel).Info("Reconcile", "request", request, "namespace", request.Namespace, "name", request.Name)
deleted := false
versionedET := &expansionv1beta1.ExpansionTemplate{}
err := r.Get(ctx, request.NamespacedName, versionedET)
if err != nil {
if !apierrors.IsNotFound(err) {
return reconcile.Result{}, err
}
deleted = true
}
et := &unversioned.ExpansionTemplate{}
if err := r.scheme.Convert(versionedET, et, nil); err != nil {
return reconcile.Result{}, err
}
oldConflicts := r.system.GetConflicts()
if !et.GetDeletionTimestamp().IsZero() {
deleted = true
}
if deleted {
// et will be an empty struct. We set the metadata name, which is
// used as a key to delete it from the expansion system
et.Name = request.Name
if err := r.system.RemoveTemplate(et); err != nil {
r.getTracker().TryCancelExpect(versionedET)
return reconcile.Result{}, err
}
log.V(logging.DebugLevel).Info("removed expansion template", "template name", et.GetName())
r.registry.remove(request.NamespacedName)
r.getTracker().CancelExpect(versionedET)
r.queueConflicts(oldConflicts)
return reconcile.Result{}, r.deleteStatus(ctx, request.NamespacedName.Name)
}
upsertErr := r.system.UpsertTemplate(et)
if upsertErr == nil {
r.getTracker().Observe(versionedET)
r.registry.add(request.NamespacedName, metrics.ActiveStatus)
} else {
r.getTracker().TryCancelExpect(versionedET)
r.registry.add(request.NamespacedName, metrics.ErrorStatus)
log.Error(upsertErr, "upserting template", "template_name", et.GetName())
}
r.queueConflicts(oldConflicts)
return reconcile.Result{}, r.updateOrCreatePodStatus(ctx, et, upsertErr)
}
func (r *Reconciler) queueConflicts(old expansion.IDSet) {
for tID := range symmetricDiff(old, r.system.GetConflicts()) {
u := &unstructured.Unstructured{}
u.SetGroupVersionKind(expansionv1beta1.GroupVersion.WithKind("ExpansionTemplate"))
// ExpansionTemplate is cluster-scoped, so we do not set namespace
u.SetName(string(tID))
r.events <- event.GenericEvent{Object: u}
}
}
func symmetricDiff(x, y expansion.IDSet) expansion.IDSet {
sDiff := make(expansion.IDSet)
for id := range x {
if _, exists := y[id]; !exists {
sDiff[id] = true
}
}
for id := range y {
if _, exists := x[id]; !exists {
sDiff[id] = true
}
}
return sDiff
}
func (r *Reconciler) deleteStatus(ctx context.Context, etName string) error {
status := &statusv1beta1.ExpansionTemplatePodStatus{}
pod, err := r.getPod(ctx)
if err != nil {
return fmt.Errorf("getting reconciler pod: %w", err)
}
sName, err := statusv1beta1.KeyForExpansionTemplate(pod.Name, etName)
if err != nil {
return fmt.Errorf("getting key for expansiontemplate: %w", err)
}
status.SetName(sName)
status.SetNamespace(util.GetNamespace())
if err := r.Delete(ctx, status); err != nil && !apierrors.IsNotFound(err) {
return err
}
return nil
}
func (r *Reconciler) updateOrCreatePodStatus(ctx context.Context, et *unversioned.ExpansionTemplate, etErr error) error {
pod, err := r.getPod(ctx)
if err != nil {
return fmt.Errorf("getting reconciler pod: %w", err)
}
// Check if it exists already
sNS := pod.Namespace
sName, err := statusv1beta1.KeyForExpansionTemplate(pod.Name, et.GetName())
if err != nil {
return fmt.Errorf("getting key for expansiontemplate: %w", err)
}
shouldCreate := true
status := &statusv1beta1.ExpansionTemplatePodStatus{}
err = r.Get(ctx, types.NamespacedName{Namespace: sNS, Name: sName}, status)
switch {
case err == nil:
shouldCreate = false
case apierrors.IsNotFound(err):
if status, err = r.newETStatus(pod, et); err != nil {
return fmt.Errorf("creating new expansiontemplate status: %w", err)
}
default:
return fmt.Errorf("getting expansion status in name %s, namespace %s: %w", et.GetName(), et.GetNamespace(), err)
}
setStatusError(status, etErr)
status.Status.ObservedGeneration = et.GetGeneration()
if shouldCreate {
return r.Create(ctx, status)
}
return r.Update(ctx, status)
}
func (r *Reconciler) newETStatus(pod *corev1.Pod, et *unversioned.ExpansionTemplate) (*statusv1beta1.ExpansionTemplatePodStatus, error) {
status, err := statusv1beta1.NewExpansionTemplateStatusForPod(pod, et.GetName(), r.scheme)
if err != nil {
return nil, fmt.Errorf("creating status for pod: %w", err)
}
status.Status.TemplateUID = et.GetUID()
return status, nil
}
func (r *Reconciler) getTracker() readiness.Expectations {
return r.tracker.For(expansionv1beta1.GroupVersion.WithKind("ExpansionTemplate"))
}
func setStatusError(status *statusv1beta1.ExpansionTemplatePodStatus, etErr error) {
if etErr == nil {
status.Status.Errors = nil
return
}
e := &statusv1beta1.ExpansionTemplateError{Message: etErr.Error()}
status.Status.Errors = []*statusv1beta1.ExpansionTemplateError{e}
}