-
Notifications
You must be signed in to change notification settings - Fork 777
/
Copy pathconstrainttemplate_controller.go
850 lines (761 loc) Β· 30.1 KB
/
constrainttemplate_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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package constrainttemplate
import (
"context"
"errors"
"fmt"
"reflect"
"time"
"github.com/open-policy-agent/frameworks/constraint/pkg/apis/templates/v1beta1"
constraintclient "github.com/open-policy-agent/frameworks/constraint/pkg/client"
"github.com/open-policy-agent/frameworks/constraint/pkg/core/templates"
statusv1beta1 "github.com/open-policy-agent/gatekeeper/v3/apis/status/v1beta1"
"github.com/open-policy-agent/gatekeeper/v3/pkg/controller/constraint"
"github.com/open-policy-agent/gatekeeper/v3/pkg/controller/constraintstatus"
"github.com/open-policy-agent/gatekeeper/v3/pkg/controller/constrainttemplatestatus"
celSchema "github.com/open-policy-agent/gatekeeper/v3/pkg/drivers/k8scel/schema"
"github.com/open-policy-agent/gatekeeper/v3/pkg/drivers/k8scel/transform"
"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/operations"
"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"
errorpkg "github.com/pkg/errors"
admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
admissionregistrationv1beta1 "k8s.io/api/admissionregistration/v1beta1"
corev1 "k8s.io/api/core/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"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"
)
const (
ctrlName = "constrainttemplate-controller"
)
var (
logger = log.Log.V(logging.DebugLevel).WithName("controller").WithValues("kind", "ConstraintTemplate", logging.Process, "constraint_template_controller")
discoveryErr *apiutil.ErrResourceDiscoveryFailed
)
var gvkConstraintTemplate = schema.GroupVersionKind{
Group: v1beta1.SchemeGroupVersion.Group,
Version: v1beta1.SchemeGroupVersion.Version,
Kind: "ConstraintTemplate",
}
type Adder struct {
CFClient *constraintclient.Client
WatchManager *watch.Manager
ControllerSwitch *watch.ControllerSwitch
Tracker *readiness.Tracker
GetPod func(context.Context) (*corev1.Pod, error)
}
// Add creates a new ConstraintTemplate Controller and adds it to the Manager with default RBAC. The Manager will set fields on the Controller
// and Start it when the Manager is Started.
func (a *Adder) Add(mgr manager.Manager) error {
if !operations.HasValidationOperations() {
return nil
}
// events will be used to receive events from dynamic watches registered
events := make(chan event.GenericEvent, 1024)
r, err := newReconciler(mgr, a.CFClient, a.WatchManager, a.ControllerSwitch, a.Tracker, events, events, a.GetPod)
if err != nil {
return err
}
return add(mgr, r)
}
func (a *Adder) InjectCFClient(c *constraintclient.Client) {
a.CFClient = c
}
func (a *Adder) InjectWatchManager(wm *watch.Manager) {
a.WatchManager = wm
}
func (a *Adder) InjectControllerSwitch(cs *watch.ControllerSwitch) {
a.ControllerSwitch = cs
}
func (a *Adder) InjectTracker(t *readiness.Tracker) {
a.Tracker = t
}
func (a *Adder) InjectGetPod(getPod func(context.Context) (*corev1.Pod, error)) {
a.GetPod = getPod
}
// newReconciler returns a new reconcile.Reconciler
// cstrEvents is the channel from which constraint controller will receive the events
// regEvents is the channel registered by Registrar to put the events in
// cstrEvents and regEvents point to same event channel except for testing.
func newReconciler(mgr manager.Manager, cfClient *constraintclient.Client, wm *watch.Manager, cs *watch.ControllerSwitch, tracker *readiness.Tracker, cstrEvents <-chan event.GenericEvent, regEvents chan<- event.GenericEvent, getPod func(context.Context) (*corev1.Pod, error)) (*ReconcileConstraintTemplate, error) {
// constraintsCache contains total number of constraints and shared mutex and vap label
constraintsCache := constraint.NewConstraintsCache()
w, err := wm.NewRegistrar(ctrlName, regEvents)
if err != nil {
return nil, err
}
statusW, err := wm.NewRegistrar(ctrlName+"-status", regEvents)
if err != nil {
return nil, err
}
// via the registrar below.
constraintAdder := constraint.Adder{
CFClient: cfClient,
ConstraintsCache: constraintsCache,
WatchManager: wm,
ControllerSwitch: cs,
Events: cstrEvents,
Tracker: tracker,
GetPod: getPod,
IfWatching: w.IfWatching,
}
// Create subordinate controller - we will feed it events dynamically via watch
if err := constraintAdder.Add(mgr); err != nil {
return nil, fmt.Errorf("registering constraint controller: %w", err)
}
if operations.IsAssigned(operations.Status) {
// statusEvents will be used to receive events from dynamic watches registered
// via the registrar below.
statusEvents := make(chan event.GenericEvent, 1024)
csAdder := constraintstatus.Adder{
CFClient: cfClient,
WatchManager: wm,
ControllerSwitch: cs,
Events: statusEvents,
IfWatching: statusW.IfWatching,
}
if err := csAdder.Add(mgr); err != nil {
return nil, err
}
ctsAdder := constrainttemplatestatus.Adder{
CfClient: cfClient,
WatchManager: wm,
ControllerSwitch: cs,
}
if err := ctsAdder.Add(mgr); err != nil {
return nil, err
}
}
r := newStatsReporter()
reconciler := &ReconcileConstraintTemplate{
Client: mgr.GetClient(),
scheme: mgr.GetScheme(),
cfClient: cfClient,
watcher: w,
statusWatcher: statusW,
cs: cs,
metrics: r,
tracker: tracker,
getPod: getPod,
cstrEvents: regEvents,
}
if getPod == nil {
reconciler.getPod = reconciler.defaultGetPod
}
return reconciler, nil
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler.
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(ctrlName, mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for changes to ConstraintTemplate
err = c.Watch(source.Kind(mgr.GetCache(), &v1beta1.ConstraintTemplate{}, &handler.TypedEnqueueRequestForObject[*v1beta1.ConstraintTemplate]{}))
if err != nil {
return err
}
// Watch for changes to ConstraintTemplateStatus
err = c.Watch(
source.Kind(mgr.GetCache(), &statusv1beta1.ConstraintTemplatePodStatus{},
handler.TypedEnqueueRequestsFromMapFunc(constrainttemplatestatus.PodStatusToConstraintTemplateMapper(true))))
if err != nil {
return err
}
// Watch for changes to Constraint CRDs
err = c.Watch(
source.Kind(mgr.GetCache(), &apiextensionsv1.CustomResourceDefinition{},
handler.TypedEnqueueRequestForOwner[*apiextensionsv1.CustomResourceDefinition](
mgr.GetScheme(),
mgr.GetRESTMapper(),
&v1beta1.ConstraintTemplate{},
handler.OnlyControllerOwner(),
)))
if err != nil {
return err
}
return nil
}
var _ reconcile.Reconciler = &ReconcileConstraintTemplate{}
// ReconcileConstraintTemplate reconciles a ConstraintTemplate object.
type ReconcileConstraintTemplate struct {
client.Client
scheme *runtime.Scheme
watcher *watch.Registrar
statusWatcher *watch.Registrar
cfClient *constraintclient.Client
cs *watch.ControllerSwitch
metrics *reporter
tracker *readiness.Tracker
getPod func(context.Context) (*corev1.Pod, error)
cstrEvents chan<- event.GenericEvent
}
// +kubebuilder:rbac:groups=admissionregistration.k8s.io,resources=validatingadmissionpolicies;validatingadmissionpolicybindings,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=templates.gatekeeper.sh,resources=constrainttemplates,verbs=get;list;watch;create;update;patch;delete
// TODO(acpana): remove in 3.16 as per https://github.com/open-policy-agent/gatekeeper/issues/3084
// +kubebuilder:rbac:groups=templates.gatekeeper.sh,resources=constrainttemplates/finalizers,verbs=get;update;patch;delete
// +kubebuilder:rbac:groups=templates.gatekeeper.sh,resources=constrainttemplates/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=externaldata.gatekeeper.sh,resources=providers,verbs=get;list;watch;create;update;patch;delete
// Reconcile reads that state of the cluster for a ConstraintTemplate object and makes changes based on the state read
// and what is in the ConstraintTemplate.Spec.
func (r *ReconcileConstraintTemplate) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {
logger := logger.WithValues("template_name", request.Name)
// Short-circuit if shutting down.
if r.cs != nil {
running := r.cs.Enter()
defer r.cs.Exit()
if !running {
return reconcile.Result{}, nil
}
}
defer r.metrics.registry.report(ctx, r.metrics)
// Fetch the ConstraintTemplate instance
deleted := false
ct := &v1beta1.ConstraintTemplate{}
err := r.Get(ctx, request.NamespacedName, ct)
if err != nil {
if !apierrors.IsNotFound(err) {
return reconcile.Result{}, err
}
deleted = true
}
deleted = deleted || !ct.GetDeletionTimestamp().IsZero()
if deleted {
ctRef := &templates.ConstraintTemplate{}
ctRef.SetNamespace(request.Namespace)
ctRef.SetName(request.Name)
ctUnversioned, err := r.cfClient.GetTemplate(ctRef)
result := reconcile.Result{}
if err != nil {
logger.Info("missing constraint template in OPA cache, no deletion necessary")
logAction(ctRef, deletedAction)
r.metrics.registry.remove(request.NamespacedName)
} else {
result, err = r.handleDelete(ctx, ctUnversioned)
if err != nil {
logger.Error(err, "deletion error")
logError(request.NamespacedName.Name)
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
return reconcile.Result{}, err
}
if !result.Requeue {
logAction(ct, deletedAction)
r.metrics.registry.remove(request.NamespacedName)
}
}
err = r.deleteAllStatus(ctx, request.Name)
return result, err
}
status, err := r.getOrCreatePodStatus(ctx, ct.Name)
if err != nil {
logger.Info("could not get/create pod status object", "error", err)
return reconcile.Result{}, err
}
status.Status.TemplateUID = ct.GetUID()
status.Status.ObservedGeneration = ct.GetGeneration()
status.Status.Errors = nil
unversionedCT := &templates.ConstraintTemplate{}
if err := r.scheme.Convert(ct, unversionedCT, nil); err != nil {
logger.Error(err, "conversion error")
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
logError(request.NamespacedName.Name)
return reconcile.Result{}, err
}
unversionedProposedCRD, err := r.cfClient.CreateCRD(ctx, unversionedCT)
if err != nil {
logger.Error(err, "CRD creation error")
r.tracker.TryCancelTemplate(unversionedCT) // Don't track templates that failed compilation
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
createErr := &v1beta1.CreateCRDError{Code: ErrCreateCode, Message: err.Error()}
status.Status.Errors = append(status.Status.Errors, createErr)
if updateErr := r.Update(ctx, status); updateErr != nil {
logger.Error(updateErr, "update status error")
return reconcile.Result{Requeue: true}, nil
}
logError(request.NamespacedName.Name)
return reconcile.Result{}, nil
}
proposedCRD := &apiextensionsv1.CustomResourceDefinition{}
if err := r.scheme.Convert(unversionedProposedCRD, proposedCRD, nil); err != nil {
logger.Error(err, "CRD conversion error")
r.tracker.TryCancelTemplate(unversionedCT) // Don't track templates that failed compilation
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
logError(request.NamespacedName.Name)
err := r.reportErrorOnCTStatus(ctx, ErrConversionCode, "Could not convert from unversioned resource", status, err)
return reconcile.Result{}, err
}
name := unversionedProposedCRD.GetName()
namespace := unversionedProposedCRD.GetNamespace()
// Check if the constraint CRD already exists
action := updatedAction
currentCRD := &apiextensionsv1.CustomResourceDefinition{}
err = r.Get(ctx, types.NamespacedName{Name: name, Namespace: namespace}, currentCRD)
switch {
case err == nil:
break
case apierrors.IsNotFound(err):
action = createdAction
currentCRD = nil
default:
logger.Error(err, "client.Get CRD error")
logError(request.NamespacedName.Name)
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
return reconcile.Result{}, err
}
generateVap, err := constraint.ShouldGenerateVAP(unversionedCT)
if err != nil && !errors.Is(err, celSchema.ErrCodeNotDefined) {
logger.Error(err, "generateVap error")
}
logger.Info("generateVap", "r.generateVap", generateVap)
result, err := r.handleUpdate(ctx, ct, unversionedCT, proposedCRD, currentCRD, status, generateVap)
if err != nil {
logger.Error(err, "handle update error")
logError(request.NamespacedName.Name)
r.metrics.registry.add(request.NamespacedName, metrics.ErrorStatus)
return result, err
}
if !result.Requeue {
logAction(ct, action)
r.metrics.registry.add(request.NamespacedName, metrics.ActiveStatus)
}
return result, err
}
func (r *ReconcileConstraintTemplate) reportErrorOnCTStatus(ctx context.Context, code, message string, status *statusv1beta1.ConstraintTemplatePodStatus, err error) error {
status.Status.Errors = []*v1beta1.CreateCRDError{}
createErr := &v1beta1.CreateCRDError{
Code: code,
Message: fmt.Sprintf("%s: %s", message, err),
}
status.Status.Errors = append(status.Status.Errors, createErr)
if err2 := r.Update(ctx, status); err2 != nil {
return errorpkg.Wrap(err, fmt.Sprintf("Could not update status: %s", err2))
}
return err
}
func (r *ReconcileConstraintTemplate) handleUpdate(
ctx context.Context,
ct *v1beta1.ConstraintTemplate,
unversionedCT *templates.ConstraintTemplate,
proposedCRD, currentCRD *apiextensionsv1.CustomResourceDefinition,
status *statusv1beta1.ConstraintTemplatePodStatus,
generateVap bool,
) (reconcile.Result, error) {
name := proposedCRD.GetName()
logger := logger.WithValues("name", ct.GetName(), "crdName", name)
logger.Info("loading code into rule engine")
beginCompile := time.Now()
// It's important that cfClient.AddTemplate() is called first. That way we can
// rely on a template's existence in rule engine to know whether a watch needs
// to be removed
if _, err := r.cfClient.AddTemplate(ctx, unversionedCT); err != nil {
if err := r.metrics.reportIngestDuration(ctx, metrics.ErrorStatus, time.Since(beginCompile)); err != nil {
logger.Error(err, "failed to report constraint template ingestion duration")
}
err := r.reportErrorOnCTStatus(ctx, ErrIngestCode, "Could not ingest Rego", status, err)
r.tracker.TryCancelTemplate(unversionedCT) // Don't track templates that failed compilation
return reconcile.Result{}, err
}
if err := r.metrics.reportIngestDuration(ctx, metrics.ActiveStatus, time.Since(beginCompile)); err != nil {
logger.Error(err, "failed to report constraint template ingestion duration")
}
// Mark for readiness tracking
t := r.tracker.For(gvkConstraintTemplate)
t.Observe(unversionedCT)
var newCRD *apiextensionsv1.CustomResourceDefinition
if currentCRD == nil {
newCRD = proposedCRD.DeepCopy()
} else {
newCRD = currentCRD.DeepCopy()
newCRD.Spec = proposedCRD.Spec
}
if err := controllerutil.SetControllerReference(ct, newCRD, r.scheme); err != nil {
return reconcile.Result{}, err
}
if currentCRD == nil {
logger.Info("creating crd")
if err := r.Create(ctx, newCRD); err != nil {
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not create CRD", status, err)
return reconcile.Result{}, err
}
} else if !reflect.DeepEqual(newCRD, currentCRD) {
logger.Info("updating crd")
if err := r.Update(ctx, newCRD); err != nil {
err := r.reportErrorOnCTStatus(ctx, ErrUpdateCode, "Could not update CRD", status, err)
return reconcile.Result{}, err
}
}
// This must go after CRD creation/update as otherwise AddWatch will always fail
logger.Info("making sure constraint is in watcher registry")
if err := r.addWatch(ctx, makeGvk(ct.Spec.CRD.Spec.Names.Kind)); err != nil {
logger.Error(err, "error adding template to watch registry")
return reconcile.Result{}, err
}
isVapAPIEnabled := false
var groupVersion *schema.GroupVersion
if generateVap {
isVapAPIEnabled, groupVersion = transform.IsVapAPIEnabled(&logger)
}
logger.Info("isVapAPIEnabled", "isVapAPIEnabled", isVapAPIEnabled)
logger.Info("groupVersion", "groupVersion", groupVersion)
if generateVap && (!isVapAPIEnabled || groupVersion == nil) {
logger.Error(constraint.ErrValidatingAdmissionPolicyAPIDisabled, "ValidatingAdmissionPolicy resource cannot be generated for ConstraintTemplate", "name", ct.GetName())
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "ValidatingAdmissionPolicy resource cannot be generated for ConstraintTemplate", status, constraint.ErrValidatingAdmissionPolicyAPIDisabled)
return reconcile.Result{}, err
}
// generating vap resources
if generateVap && isVapAPIEnabled && groupVersion != nil {
currentVap, err := vapForVersion(groupVersion)
if err != nil {
logger.Error(err, "error getting vap object with respective groupVersion")
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not get VAP with runtime group version", status, err)
return reconcile.Result{}, err
}
vapName := fmt.Sprintf("gatekeeper-%s", unversionedCT.GetName())
logger.Info("check if vap exists", "vapName", vapName)
if err := r.Get(ctx, types.NamespacedName{Name: vapName}, currentVap); err != nil {
if !apierrors.IsNotFound(err) && !errors.As(err, &discoveryErr) && !meta.IsNoMatchError(err) {
return reconcile.Result{}, err
}
currentVap = nil
}
logger.Info("get vap", "vapName", vapName, "currentVap", currentVap)
transformedVap, err := transform.TemplateToPolicyDefinition(unversionedCT)
if err != nil {
logger.Error(err, "transform to vap error", "vapName", vapName)
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not transform to vap object", status, err)
return reconcile.Result{}, err
}
newVap, err := getRunTimeVAP(groupVersion, transformedVap, currentVap)
if err != nil {
logger.Error(err, "getRunTimeVAP error", "vapName", vapName)
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not get runtime vap object", status, err)
return reconcile.Result{}, err
}
if err := controllerutil.SetControllerReference(ct, newVap, r.scheme); err != nil {
return reconcile.Result{}, err
}
if currentVap == nil {
logger.Info("creating vap", "vapName", vapName)
if err := r.Create(ctx, newVap); err != nil {
logger.Info("creating vap error", "vapName", vapName, "error", err)
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not create vap object", status, err)
return reconcile.Result{}, err
}
// after vap is created, trigger update event for all constraints
if err := r.triggerConstraintEvents(ctx, ct, status); err != nil {
return reconcile.Result{}, err
}
} else if !reflect.DeepEqual(currentVap, newVap) {
logger.Info("updating vap")
if err := r.Update(ctx, newVap); err != nil {
err := r.reportErrorOnCTStatus(ctx, ErrUpdateCode, "Could not update vap object", status, err)
return reconcile.Result{}, err
}
}
}
// do not generate vap resources
// remove if exists
if !generateVap && isVapAPIEnabled && groupVersion != nil {
currentVap, err := vapForVersion(groupVersion)
if err != nil {
logger.Error(err, "error getting vap object with respective groupVersion")
err := r.reportErrorOnCTStatus(ctx, ErrCreateCode, "Could not get VAP with correct group version", status, err)
return reconcile.Result{}, err
}
vapName := fmt.Sprintf("gatekeeper-%s", unversionedCT.GetName())
logger.Info("check if vap exists", "vapName", vapName)
if err := r.Get(ctx, types.NamespacedName{Name: vapName}, currentVap); err != nil {
if !apierrors.IsNotFound(err) && !errors.As(err, &discoveryErr) && !meta.IsNoMatchError(err) {
return reconcile.Result{}, err
}
currentVap = nil
}
if currentVap != nil {
logger.Info("deleting vap")
if err := r.Delete(ctx, currentVap); err != nil {
err := r.reportErrorOnCTStatus(ctx, ErrUpdateCode, "Could not delete vap object", status, err)
return reconcile.Result{}, err
}
// after vap is deleted, trigger update event for all constraints
if err := r.triggerConstraintEvents(ctx, ct, status); err != nil {
return reconcile.Result{}, err
}
}
}
if err := r.Update(ctx, status); err != nil {
logger.Error(err, "update ct pod status error")
return reconcile.Result{Requeue: true}, nil
}
return reconcile.Result{}, nil
}
func (r *ReconcileConstraintTemplate) handleDelete(
ctx context.Context,
ct *templates.ConstraintTemplate,
) (reconcile.Result, error) {
logger := logger.WithValues("name", ct.GetName())
logger.Info("removing from watcher registry")
gvk := makeGvk(ct.Spec.CRD.Spec.Names.Kind)
if err := r.removeWatch(ctx, gvk); err != nil {
return reconcile.Result{}, err
}
r.tracker.CancelTemplate(ct)
// removing the template from the OPA cache must go last as we are relying
// on that cache to derive the Kind to remove from the watch
if _, err := r.cfClient.RemoveTemplate(ctx, ct); err != nil {
return reconcile.Result{}, err
}
return reconcile.Result{}, nil
}
func (r *ReconcileConstraintTemplate) defaultGetPod(_ context.Context) (*corev1.Pod, error) {
// require injection of GetPod in order to control what client we use to
// guarantee we don't inadvertently create a watch
panic("GetPod must be injected to ReconcileConstraintTemplate")
}
func (r *ReconcileConstraintTemplate) deleteAllStatus(ctx context.Context, ctName string) error {
statusObj := &statusv1beta1.ConstraintTemplatePodStatus{}
sName, err := statusv1beta1.KeyForConstraintTemplate(util.GetPodName(), ctName)
if err != nil {
return err
}
statusObj.SetName(sName)
statusObj.SetNamespace(util.GetNamespace())
if err := r.Delete(ctx, statusObj); err != nil {
if !apierrors.IsNotFound(err) {
return err
}
}
cstrStatusObjs := &statusv1beta1.ConstraintPodStatusList{}
if err := r.List(ctx, cstrStatusObjs, client.MatchingLabels(map[string]string{
statusv1beta1.PodLabel: util.GetPodName(),
statusv1beta1.ConstraintTemplateNameLabel: ctName,
})); err != nil {
return err
}
for index := range cstrStatusObjs.Items {
if err := r.Delete(ctx, &cstrStatusObjs.Items[index]); err != nil {
if !apierrors.IsNotFound(err) {
return err
}
}
}
return nil
}
func (r *ReconcileConstraintTemplate) getOrCreatePodStatus(ctx context.Context, ctName string) (*statusv1beta1.ConstraintTemplatePodStatus, error) {
statusObj := &statusv1beta1.ConstraintTemplatePodStatus{}
sName, err := statusv1beta1.KeyForConstraintTemplate(util.GetPodName(), ctName)
if err != nil {
return nil, err
}
key := types.NamespacedName{Name: sName, Namespace: util.GetNamespace()}
if err := r.Get(ctx, key, statusObj); err != nil {
if !apierrors.IsNotFound(err) {
return nil, err
}
} else {
return statusObj, nil
}
pod, err := r.getPod(ctx)
if err != nil {
return nil, err
}
statusObj, err = statusv1beta1.NewConstraintTemplateStatusForPod(pod, ctName, r.scheme)
if err != nil {
return nil, err
}
if err := r.Create(ctx, statusObj); err != nil {
return nil, err
}
return statusObj, nil
}
func (r *ReconcileConstraintTemplate) addWatch(ctx context.Context, kind schema.GroupVersionKind) error {
if err := r.watcher.AddWatch(ctx, kind); err != nil {
return err
}
return r.statusWatcher.AddWatch(ctx, kind)
}
func (r *ReconcileConstraintTemplate) removeWatch(ctx context.Context, kind schema.GroupVersionKind) error {
if err := r.watcher.RemoveWatch(ctx, kind); err != nil {
return err
}
return r.statusWatcher.RemoveWatch(ctx, kind)
}
func (r *ReconcileConstraintTemplate) listObjects(ctx context.Context, gvk schema.GroupVersionKind) ([]unstructured.Unstructured, error) {
list := &unstructured.UnstructuredList{
Object: map[string]interface{}{},
Items: []unstructured.Unstructured{},
}
gvk.Kind += "List"
list.SetGroupVersionKind(gvk)
err := r.List(ctx, list)
if err != nil {
return nil, err
}
return list.Items, nil
}
func (r *ReconcileConstraintTemplate) triggerConstraintEvents(ctx context.Context, ct *v1beta1.ConstraintTemplate, status *statusv1beta1.ConstraintTemplatePodStatus) error {
gvk := makeGvk(ct.Spec.CRD.Spec.Names.Kind)
logger.Info("list gvk objects", "gvk", gvk)
cstrObjs, err := r.listObjects(ctx, gvk)
if err != nil {
logger.Error(err, "get all constraints listObjects")
err := r.reportErrorOnCTStatus(ctx, ErrUpdateCode, "Could not list all constraint objects", status, err)
return err
}
logger.Info("list gvk objects", "cstrObjs", cstrObjs)
for _, cstr := range cstrObjs {
c := cstr
logger.Info("triggering cstrEvent")
r.cstrEvents <- event.GenericEvent{Object: &c}
}
return nil
}
type action string
const (
createdAction = action("created")
updatedAction = action("updated")
deletedAction = action("deleted")
)
type namedObj interface {
GetName() string
}
func logAction(template namedObj, a action) {
logger.Info(
fmt.Sprintf("template was %s", string(a)),
logging.EventType, fmt.Sprintf("template_%s", string(a)),
logging.TemplateName, template.GetName(),
)
}
func logError(name string) {
logger.Info(
"unable to ingest template",
logging.EventType, "template_ingest_error",
logging.TemplateName, name,
)
}
func makeGvk(kind string) schema.GroupVersionKind {
return schema.GroupVersionKind{
Group: "constraints.gatekeeper.sh",
Version: "v1beta1",
Kind: kind,
}
}
func vapForVersion(gvk *schema.GroupVersion) (client.Object, error) {
switch gvk.Version {
case "v1":
return &admissionregistrationv1.ValidatingAdmissionPolicy{}, nil
case "v1beta1":
return &admissionregistrationv1beta1.ValidatingAdmissionPolicy{}, nil
default:
return nil, errors.New("unrecognized version")
}
}
func getRunTimeVAP(gvk *schema.GroupVersion, transformedVap *admissionregistrationv1beta1.ValidatingAdmissionPolicy, currentVap client.Object) (client.Object, error) {
if currentVap == nil {
if gvk.Version == "v1" {
return v1beta1ToV1(transformedVap)
}
return transformedVap.DeepCopy(), nil
}
if gvk.Version == "v1" {
v1CurrentVAP, ok := currentVap.(*admissionregistrationv1.ValidatingAdmissionPolicy)
if !ok {
return nil, errors.New("Unable to convert to v1 VAP")
}
v1CurrentVAP = v1CurrentVAP.DeepCopy()
tempVAP, err := v1beta1ToV1(transformedVap)
if err != nil {
return nil, err
}
v1CurrentVAP.Spec = tempVAP.Spec
return v1CurrentVAP, nil
}
v1beta1VAP, ok := currentVap.(*admissionregistrationv1beta1.ValidatingAdmissionPolicy)
if !ok {
return nil, errors.New("Unable to convert to v1 VAP")
}
v1beta1VAP.Spec = transformedVap.Spec
return v1beta1VAP.DeepCopy(), nil
}
func v1beta1ToV1(v1beta1Obj *admissionregistrationv1beta1.ValidatingAdmissionPolicy) (*admissionregistrationv1.ValidatingAdmissionPolicy, error) {
// TODO(jgabani): Use r.scheme.Convert to convert from v1beta1 to v1 once the conversion bug is fixed - https://github.com/kubernetes/kubernetes/issues/126582
obj := &admissionregistrationv1.ValidatingAdmissionPolicy{}
obj.SetName(v1beta1Obj.GetName())
obj.Spec.ParamKind = &admissionregistrationv1.ParamKind{
APIVersion: v1beta1Obj.Spec.ParamKind.APIVersion,
Kind: v1beta1Obj.Spec.ParamKind.Kind,
}
obj.Spec.MatchConstraints = &admissionregistrationv1.MatchResources{
ResourceRules: []admissionregistrationv1.NamedRuleWithOperations{
{
RuleWithOperations: admissionregistrationv1beta1.RuleWithOperations{
/// TODO(jgabani): default for now until we can safely expose these to users
Operations: []admissionregistrationv1.OperationType{admissionregistrationv1.Create, admissionregistrationv1.Update},
Rule: admissionregistrationv1beta1.Rule{APIGroups: []string{"*"}, APIVersions: []string{"*"}, Resources: []string{"*"}},
},
},
},
}
obj.Spec.MatchConditions = []admissionregistrationv1.MatchCondition{}
for _, matchCondition := range v1beta1Obj.Spec.MatchConditions {
obj.Spec.MatchConditions = append(obj.Spec.MatchConditions, admissionregistrationv1.MatchCondition{
Name: matchCondition.Name,
Expression: matchCondition.Expression,
})
}
obj.Spec.Validations = []admissionregistrationv1.Validation{}
for _, v := range v1beta1Obj.Spec.Validations {
obj.Spec.Validations = append(obj.Spec.Validations, admissionregistrationv1.Validation{
Expression: v.Expression,
Message: v.Message,
MessageExpression: v.MessageExpression,
})
}
var failurePolicy admissionregistrationv1.FailurePolicyType
switch *v1beta1Obj.Spec.FailurePolicy {
case admissionregistrationv1beta1.Ignore:
failurePolicy = admissionregistrationv1.Ignore
case admissionregistrationv1beta1.Fail:
failurePolicy = admissionregistrationv1.Fail
default:
return nil, fmt.Errorf("%w: unrecognized failure policy: %s", celSchema.ErrBadFailurePolicy, *v1beta1Obj.Spec.FailurePolicy)
}
obj.Spec.FailurePolicy = &failurePolicy
obj.Spec.AuditAnnotations = nil
for _, v := range v1beta1Obj.Spec.Variables {
obj.Spec.Variables = append(obj.Spec.Variables, admissionregistrationv1.Variable{
Name: v.Name,
Expression: v.Expression,
})
}
return obj, nil
}