-
Notifications
You must be signed in to change notification settings - Fork 42
/
reposync_controller.go
1310 lines (1195 loc) · 49.6 KB
/
reposync_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
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2022 Google LLC
//
// 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 controllers
import (
"context"
"errors"
"fmt"
"slices"
"strings"
"sync"
"time"
"github.com/go-logr/logr"
"github.com/google/go-cmp/cmp"
admissionv1 "k8s.io/api/admissionregistration/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/client-go/dynamic"
"k8s.io/klog/v2"
"kpt.dev/configsync/pkg/api/configsync"
"kpt.dev/configsync/pkg/api/configsync/v1beta1"
hubv1 "kpt.dev/configsync/pkg/api/hub/v1"
"kpt.dev/configsync/pkg/core"
"kpt.dev/configsync/pkg/declared"
"kpt.dev/configsync/pkg/kinds"
"kpt.dev/configsync/pkg/metadata"
"kpt.dev/configsync/pkg/metrics"
"kpt.dev/configsync/pkg/reconcilermanager"
"kpt.dev/configsync/pkg/reposync"
"kpt.dev/configsync/pkg/status"
"kpt.dev/configsync/pkg/util/compare"
"kpt.dev/configsync/pkg/util/mutate"
"kpt.dev/configsync/pkg/validate/raw/validate"
webhookconfiguration "kpt.dev/configsync/pkg/webhook/configuration"
kstatus "sigs.k8s.io/cli-utils/pkg/kstatus/status"
controllerruntime "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
// RepoSyncReconciler reconciles a RepoSync object.
type RepoSyncReconciler struct {
reconcilerBase
// lock ensures that the Reconcile method only runs one at a time.
lock sync.Mutex
// configMapWatches stores which namespaces where we are currently watching ConfigMaps
configMapWatches map[string]bool
controller controller.Controller
cache cache.Cache
}
const (
// the following annotations are added to ConfigMaps that are copied from references
// in spec.helm.valuesFileRefs to the config-management-system namespace, to keep track
// of where the ConfigMap came from for cleanup
repoSyncNameAnnotationKey = configsync.ConfigSyncPrefix + "repo-sync-name"
repoSyncNamespaceAnnotationKey = configsync.ConfigSyncPrefix + "repo-sync-namespace"
// originalConfigMapNameAnnotationKey isn't used anywhere, but is added to ConfigMaps that are
// copied from references in spec.helm.valuesFileRefs to the config-management-system namespace,
// to keep track of where the ConfigMap came from, for debugging and troubleshooting
originalConfigMapNameAnnotationKey = configsync.ConfigSyncPrefix + "original-configmap-name"
)
// NewRepoSyncReconciler returns a new RepoSyncReconciler.
func NewRepoSyncReconciler(clusterName string, reconcilerPollingPeriod, hydrationPollingPeriod time.Duration, client client.Client, watcher client.WithWatch, dynamicClient dynamic.Interface, log logr.Logger, scheme *runtime.Scheme) *RepoSyncReconciler {
lc := loggingController{log}
return &RepoSyncReconciler{
reconcilerBase: reconcilerBase{
loggingController: lc,
reconcilerFinalizerHandler: nsReconcilerFinalizerHandler{lc, client},
clusterName: clusterName,
client: client,
dynamicClient: dynamicClient,
watcher: watcher,
scheme: scheme,
reconcilerPollingPeriod: reconcilerPollingPeriod,
hydrationPollingPeriod: hydrationPollingPeriod,
syncKind: configsync.RepoSyncKind,
knownHostExist: false,
},
configMapWatches: make(map[string]bool),
}
}
// +kubebuilder:rbac:groups=configsync.gke.io,resources=reposyncs,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=configsync.gke.io,resources=reposyncs/status,verbs=get;update;patch
// +kubebuilder:rbac:groups="",resources=configmaps,verbs=get;list;watch;create;update;patch;delete
// Reconcile the RepoSync resource.
func (r *RepoSyncReconciler) Reconcile(ctx context.Context, req controllerruntime.Request) (controllerruntime.Result, error) {
r.lock.Lock()
defer r.lock.Unlock()
rsRef := req.NamespacedName
start := time.Now()
reconcilerRef := types.NamespacedName{
Namespace: configsync.ControllerNamespace,
Name: core.NsReconcilerName(rsRef.Namespace, rsRef.Name),
}
ctx = r.setLoggerValues(ctx,
logFieldSyncKind, r.syncKind,
logFieldSyncRef, rsRef.String(),
logFieldReconciler, reconcilerRef.String())
rs := &v1beta1.RepoSync{}
if err := r.client.Get(ctx, rsRef, rs); err != nil {
if apierrors.IsNotFound(err) {
// Cleanup after already deleted RepoSync.
// This code path is unlikely, because the custom finalizer should
// have already deleted the managed resources and removed the
// repoSyncs cache entry. But if we get here, clean up anyway.
if err := r.deleteManagedObjects(ctx, reconcilerRef, rsRef); err != nil {
r.logger(ctx).Error(err, "Failed to delete managed objects")
// Failed to delete a managed object.
// Return an error to trigger retry.
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
// requeue for retry
return controllerruntime.Result{}, fmt.Errorf("failed to delete managed objects: %w", err)
}
// cleanup successful
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(nil), start)
return controllerruntime.Result{}, nil
}
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
return controllerruntime.Result{}, status.APIServerError(err, "failed to get RepoSync")
}
if rs.DeletionTimestamp.IsZero() {
// Only validate RepoSync if it is not deleting. Otherwise, the validation
// error will block the finalizer.
if err := r.watchConfigMaps(rs); err != nil {
r.logger(ctx).Error(err, "Error watching ConfigMaps")
_, updateErr := r.updateSyncStatus(ctx, rs, reconcilerRef, func(_ *v1beta1.RepoSync) error {
reposync.SetStalled(rs, "ConfigMapWatch", err)
return nil
})
if updateErr != nil {
r.logger(ctx).Error(updateErr, "Sync status update failed")
}
// Use the watch setup error for metric tagging.
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
// Watch errors may be recoverable, so we retry (return the error)
return controllerruntime.Result{}, err
}
// Validate the RepoSync after the ConfigMap watch is set up, so new
// ConfigMaps can be validated.
if err := r.validateRepoSync(ctx, rs, reconcilerRef.Name); err != nil {
r.logger(ctx).Error(err, "Invalid RepoSync Spec")
_, updateErr := r.updateSyncStatus(ctx, rs, reconcilerRef, func(_ *v1beta1.RepoSync) error {
reposync.SetStalled(rs, "Validation", err)
return nil
})
// Use the validation error for metric tagging.
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
// Spec errors are not recoverable without user input.
// So only retry if there was an updateErr.
return controllerruntime.Result{}, updateErr
}
} else {
r.logger(ctx).V(3).Info("Sync deletion timestamp detected")
}
enabled, err := r.isWebhookEnabled(ctx)
if err != nil {
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
return controllerruntime.Result{}, fmt.Errorf("failed to get the admission webhook configuration: %w", err)
}
r.webhookEnabled = enabled
setupFn := func(ctx context.Context) error {
return r.setup(ctx, reconcilerRef, rs)
}
teardownFn := func(ctx context.Context) error {
return r.teardown(ctx, reconcilerRef, rs)
}
if err := r.setupOrTeardown(ctx, rs, setupFn, teardownFn); err != nil {
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(err), start)
return controllerruntime.Result{}, err
}
metrics.RecordReconcileDuration(ctx, metrics.StatusTagKey(nil), start)
return controllerruntime.Result{}, nil
}
func (r *RepoSyncReconciler) upsertManagedObjects(ctx context.Context, reconcilerRef types.NamespacedName, rs *v1beta1.RepoSync) error {
rsRef := client.ObjectKeyFromObject(rs)
r.logger(ctx).V(3).Info("Reconciling managed objects")
labelMap := ManagedObjectLabelMap(r.syncKind, rsRef)
// Create secret in config-management-system namespace using the
// existing secret in the reposync.namespace.
authSecret, err := r.upsertAuthSecret(ctx, rs, reconcilerRef, labelMap)
if err != nil {
return fmt.Errorf("upserting auth secret: %w", err)
}
// Create secret in config-management-system namespace using the
// existing secret in the reposync.namespace.
caSecret, err := r.upsertCACertSecret(ctx, rs, reconcilerRef, labelMap)
if err != nil {
return fmt.Errorf("upserting CA cert secret: %w", err)
}
if err := r.deleteSecrets(ctx, reconcilerRef, authSecret.Name, caSecret.Name); err != nil {
return fmt.Errorf("garbage collecting secrets: %w", err)
}
// Overwrite reconciler pod ServiceAccount.
var auth configsync.AuthType
var gcpSAEmail string
switch rs.Spec.SourceType {
case configsync.GitSource:
auth = rs.Spec.Auth
gcpSAEmail = rs.Spec.GCPServiceAccountEmail
case configsync.OciSource:
auth = rs.Spec.Oci.Auth
gcpSAEmail = rs.Spec.Oci.GCPServiceAccountEmail
case configsync.HelmSource:
auth = rs.Spec.Helm.Auth
gcpSAEmail = rs.Spec.Helm.GCPServiceAccountEmail
default:
// Should have been caught by validation
return fmt.Errorf("invalid source type: %s", rs.Spec.SourceType)
}
if _, err := r.upsertServiceAccount(ctx, reconcilerRef, auth, gcpSAEmail, labelMap); err != nil {
return fmt.Errorf("upserting service account: %w", err)
}
// Namespace-scoped read/write permissions
if _, err := r.upsertSharedRoleBinding(ctx, reconcilerRef, rsRef); err != nil {
return fmt.Errorf("upserting role binding: %w", err)
}
// Cluster-scoped read permissions
if err := r.upsertSharedClusterRoleBinding(ctx, RepoSyncClusterScopeClusterRoleBindingName, RepoSyncClusterScopeClusterRoleName, reconcilerRef, rsRef); err != nil {
return fmt.Errorf("upserting role binding: %w", err)
}
if err := r.upsertHelmConfigMaps(ctx, rs, labelMap); err != nil {
return fmt.Errorf("upserting helm config maps: %w", err)
}
containerEnvs := r.populateContainerEnvs(ctx, rs, reconcilerRef.Name)
mut := r.mutationsFor(ctx, rs, containerEnvs)
// Upsert Namespace reconciler deployment.
deployObj, op, err := r.upsertDeployment(ctx, reconcilerRef, labelMap, mut)
if err != nil {
return fmt.Errorf("upserting reconciler deployment: %w", err)
}
rs.Status.Reconciler = reconcilerRef.Name
// Get the latest deployment to check the status.
// For other operations, upsertDeployment will have returned the latest already.
if op == controllerutil.OperationResultNone {
deployObj, err = r.deployment(ctx, reconcilerRef)
if err != nil {
return fmt.Errorf("getting reconciler deployment: %w", err)
}
}
gvk, err := kinds.Lookup(deployObj, r.scheme)
if err != nil {
return err
}
deployID := core.ID{
ObjectKey: reconcilerRef,
GroupKind: gvk.GroupKind(),
}
result, err := kstatus.Compute(deployObj)
if err != nil {
return fmt.Errorf("computing reconciler deployment status: %w", err)
}
r.logger(ctx).V(3).Info("Reconciler status",
logFieldObjectRef, deployID.ObjectKey.String(),
logFieldObjectKind, deployID.Kind,
logFieldResourceVersion, deployObj.GetResourceVersion(),
"status", result.Status,
"message", result.Message)
if result.Status != kstatus.CurrentStatus {
// reconciler deployment failed or not yet available
err := errors.New(result.Message)
return NewObjectReconcileErrorWithID(err, deployID, result.Status)
}
// success - reconciler deployment is available
return nil
}
// setup performs the following steps:
// - Patch RepoSync to upsert ApplySet metadata
// - Create or update managed objects
// - Convert any error into RepoSync status conditions
// - Update the RepoSync status
func (r *RepoSyncReconciler) setup(ctx context.Context, reconcilerRef types.NamespacedName, rs *v1beta1.RepoSync) error {
_, err := r.patchSyncMetadata(ctx, rs)
if err == nil {
err = r.upsertManagedObjects(ctx, reconcilerRef, rs)
}
updated, updateErr := r.updateSyncStatus(ctx, rs, reconcilerRef, func(syncObj *v1beta1.RepoSync) error {
// Modify the sync status,
// but keep the upsert error separate from the status update error.
err = r.handleReconcileError(ctx, err, syncObj, "Setup")
return nil
})
switch {
case updateErr != nil && err == nil:
// Return the updateSyncStatus error and re-reconcile
return updateErr
case err != nil:
if updateErr != nil {
r.logger(ctx).Error(updateErr, "Sync status update failed")
}
// Return the upsertManagedObjects error and re-reconcile
return err
default: // both nil
if updated {
r.logger(ctx).Info("Setup successful")
}
return nil
}
}
// teardown performs the following teardown steps:
// - Delete managed objects
// - Convert any error into RepoSync status conditions
// - Update the RepoSync status
func (r *RepoSyncReconciler) teardown(ctx context.Context, reconcilerRef types.NamespacedName, rs *v1beta1.RepoSync) error {
rsRef := client.ObjectKeyFromObject(rs)
err := r.deleteManagedObjects(ctx, reconcilerRef, rsRef)
updated, updateErr := r.updateSyncStatus(ctx, rs, reconcilerRef, func(syncObj *v1beta1.RepoSync) error {
// Modify the sync status,
// but keep the upsert error separate from the status update error.
err = r.handleReconcileError(ctx, err, syncObj, "Teardown")
return nil
})
switch {
case updateErr != nil && err == nil:
// Return the updateSyncStatus error and re-reconcile
return updateErr
case err != nil:
if updateErr != nil {
r.logger(ctx).Error(updateErr, "Sync status update failed")
}
// Return the upsertManagedObjects error and re-reconcile
return err
default: // both nil
if updated {
r.logger(ctx).Info("Teardown successful")
}
return nil
}
}
// handleReconcileError updates the sync object status to reflect the Reconcile
// error. If the error requires immediate retry, it will be returned.
func (r *RepoSyncReconciler) handleReconcileError(ctx context.Context, err error, rs *v1beta1.RepoSync, stage string) error {
if err == nil {
reposync.ClearCondition(rs, v1beta1.RepoSyncReconciling)
reposync.ClearCondition(rs, v1beta1.RepoSyncStalled)
return nil // no retry
}
// Most errors are either ObjectOperationError or ObjectReconcileError.
// The type of error indicates whether setup/teardown is stalled or still making progress (waiting for next event).
var opErr *ObjectOperationError
var statusErr *ObjectReconcileError
if errors.As(err, &opErr) {
// Metadata from ManagedObjectOperationError used for log context
r.logger(ctx).Error(err, fmt.Sprintf("%s failed", stage),
logFieldObjectRef, opErr.ID.ObjectKey.String(),
logFieldObjectKind, opErr.ID.Kind,
logFieldOperation, opErr.Operation)
reposync.SetReconciling(rs, stage, fmt.Sprintf("%s stalled", stage))
reposync.SetStalled(rs, opErr.ID.Kind, err)
} else if errors.As(err, &statusErr) {
// Metadata from ObjectReconcileError used for log context
r.logger(ctx).Error(err, fmt.Sprintf("%s waiting for event", stage),
logFieldObjectRef, statusErr.ID.ObjectKey.String(),
logFieldObjectKind, statusErr.ID.Kind,
logFieldObjectStatus, statusErr.Status)
switch statusErr.Status {
case kstatus.InProgressStatus, kstatus.TerminatingStatus:
// still making progress
reposync.SetReconciling(rs, statusErr.ID.Kind, err.Error())
reposync.ClearCondition(rs, v1beta1.RepoSyncStalled)
return NewNoRetryError(err) // no immediate retry - wait for next event
default:
// failed or invalid
reposync.SetReconciling(rs, stage, fmt.Sprintf("%s stalled", stage))
reposync.SetStalled(rs, statusErr.ID.Kind, err)
}
} else {
r.logger(ctx).Error(err, fmt.Sprintf("%s failed", stage))
reposync.SetReconciling(rs, stage, fmt.Sprintf("%s stalled", stage))
reposync.SetStalled(rs, "Error", err)
}
if err != nil {
err = fmt.Errorf("%s: %w", stage, err)
}
return err // retry
}
// deleteManagedObjects deletes objects managed by the reconciler-manager for
// this RepoSync.
func (r *RepoSyncReconciler) deleteManagedObjects(ctx context.Context, reconcilerRef, rsRef types.NamespacedName) error {
r.logger(ctx).Info("Deleting managed objects")
if err := r.deleteDeployment(ctx, reconcilerRef); err != nil {
return fmt.Errorf("deleting reconciler deployment: %w", err)
}
// Note: ConfigMaps have been replaced by Deployment env vars.
// Using env vars auto-updates the Deployment when they change.
// This deletion remains to clean up after users upgrade.
if err := r.deleteConfigMaps(ctx, reconcilerRef); err != nil {
return fmt.Errorf("deleting config maps: %w", err)
}
if err := r.deleteSecrets(ctx, reconcilerRef); err != nil {
return fmt.Errorf("deleting secrets: %w", err)
}
if err := r.deleteSharedRoleBinding(ctx, reconcilerRef, rsRef); err != nil {
return fmt.Errorf("deleting role binding: %w", err)
}
if err := r.deleteSharedClusterRoleBinding(ctx, RepoSyncClusterScopeClusterRoleBindingName, reconcilerRef); err != nil {
return fmt.Errorf("deleting cluster role binding: %w", err)
}
if err := r.deleteHelmConfigMapCopies(ctx, rsRef, nil); err != nil {
return fmt.Errorf("deleting helm config maps: %w", err)
}
if err := r.deleteServiceAccount(ctx, reconcilerRef); err != nil {
return fmt.Errorf("deleting service account: %w", err)
}
return nil
}
// Register RepoSync controller with reconciler-manager.
func (r *RepoSyncReconciler) Register(mgr controllerruntime.Manager, watchFleetMembership bool) error {
r.lock.Lock()
defer r.lock.Unlock()
// Avoid re-registering the controller
if r.controller != nil {
return nil
}
controllerBuilder := controllerruntime.NewControllerManagedBy(mgr).
WithOptions(controller.Options{
MaxConcurrentReconciles: 1,
}).
For(&v1beta1.RepoSync{}).
// Custom Watch to trigger Reconcile for objects created by RepoSync controller.
Watches(&corev1.Secret{},
handler.EnqueueRequestsFromMapFunc(r.mapSecretToRepoSyncs),
builder.WithPredicates(predicate.ResourceVersionChangedPredicate{})).
Watches(withNamespace(&appsv1.Deployment{}, configsync.ControllerNamespace),
handler.EnqueueRequestsFromMapFunc(r.mapObjectToRepoSync),
builder.WithPredicates(predicate.ResourceVersionChangedPredicate{})).
Watches(withNamespace(&corev1.ServiceAccount{}, configsync.ControllerNamespace),
handler.EnqueueRequestsFromMapFunc(r.mapObjectToRepoSync),
builder.WithPredicates(predicate.ResourceVersionChangedPredicate{})).
// Watch RoleBindings in all namespaces, because RoleBindings are created
// in the namespace of the RepoSync. Only maps to existing RepoSyncs.
Watches(&rbacv1.RoleBinding{},
handler.EnqueueRequestsFromMapFunc(r.mapObjectToRepoSync),
builder.WithPredicates(predicate.ResourceVersionChangedPredicate{})).
Watches(&admissionv1.ValidatingWebhookConfiguration{},
handler.EnqueueRequestsFromMapFunc(r.mapAdmissionWebhookToRepoSyncs),
builder.WithPredicates(predicate.ResourceVersionChangedPredicate{}))
if watchFleetMembership {
// Custom Watch for membership to trigger reconciliation.
controllerBuilder.Watches(&hubv1.Membership{},
handler.EnqueueRequestsFromMapFunc(r.mapMembershipToRepoSyncs),
builder.WithPredicates(predicate.GenerationChangedPredicate{}))
}
ctrlr, err := controllerBuilder.Build(r)
r.controller = ctrlr
r.cache = mgr.GetCache()
return err
}
func (r *RepoSyncReconciler) watchConfigMaps(rs *v1beta1.RepoSync) error {
// We add watches dynamically at runtime based on the RepoSync namespace
// in order to avoid watching ConfigMaps in the entire cluster.
if rs == nil || rs.Spec.SourceType != configsync.HelmSource || rs.Spec.Helm == nil ||
len(rs.Spec.Helm.ValuesFileRefs) == 0 {
// TODO: When it's available, we should remove unneeded watches from the controller
// when all RepoSyncs with ConfigMap references in a particular namespace are
// deleted (or are no longer referencing ConfigMaps).
// See https://github.com/kubernetes-sigs/controller-runtime/pull/2159
// and https://github.com/kubernetes-sigs/controller-runtime/issues/1884
return nil
}
if _, ok := r.configMapWatches[rs.Namespace]; !ok {
klog.Infoln("Adding watch for ConfigMaps in namespace ", rs.Namespace)
ctrlr := r.controller
if err := ctrlr.Watch(source.Kind(r.cache, withNamespace(&corev1.ConfigMap{}, rs.Namespace),
handler.EnqueueRequestsFromMapFunc(r.mapConfigMapToRepoSyncs),
predicate.ResourceVersionChangedPredicate{})); err != nil {
return err
}
r.configMapWatches[rs.Namespace] = true
}
return nil
}
func (r *RepoSyncReconciler) mapMembershipToRepoSyncs(ctx context.Context, o client.Object) []reconcile.Request {
// Clear the membership if the cluster is unregistered
if err := r.client.Get(ctx, types.NamespacedName{Name: fleetMembershipName}, &hubv1.Membership{}); err != nil {
if apierrors.IsNotFound(err) {
klog.Info("Fleet Membership not found, clearing membership cache")
r.membership = nil
return r.requeueAllRepoSyncs(fleetMembershipName)
}
klog.Errorf("Fleet Membership get failed: %v", err)
return nil
}
m, isMembership := o.(*hubv1.Membership)
if !isMembership {
klog.Errorf("Fleet Membership expected, found %q", o.GetObjectKind().GroupVersionKind())
return nil
}
if m.Name != fleetMembershipName {
klog.Errorf("Fleet Membership name expected %q, found %q", fleetMembershipName, m.Name)
return nil
}
r.membership = m
return r.requeueAllRepoSyncs(fleetMembershipName)
}
func (r *RepoSyncReconciler) requeueAllRepoSyncs(name string) []reconcile.Request {
//TODO: pass through context (reqs updating controller-runtime)
ctx := context.Background()
allRepoSyncs := &v1beta1.RepoSyncList{}
if err := r.client.List(ctx, allRepoSyncs); err != nil {
klog.Errorf("RepoSync list failed: %v", err)
return nil
}
requests := make([]reconcile.Request, len(allRepoSyncs.Items))
for i, rs := range allRepoSyncs.Items {
requests[i] = reconcile.Request{
NamespacedName: client.ObjectKeyFromObject(&rs),
}
}
if len(requests) > 0 {
klog.Infof("Changes to %s trigger reconciliations for %d RepoSync objects.", name, len(allRepoSyncs.Items))
}
return requests
}
// mapSecretToRepoSyncs define a mapping from the Secret object to its attached
// RepoSync objects via the following fields:
// - `spec.git.secretRef.name`
// - `spec.git.caCertSecretRef.name`
// - `spec.helm.secretRef.name`
// The update to the Secret object will trigger a reconciliation of the RepoSync objects.
func (r *RepoSyncReconciler) mapSecretToRepoSyncs(ctx context.Context, secret client.Object) []reconcile.Request {
sRef := client.ObjectKeyFromObject(secret)
// map the copied ns-reconciler Secret in the config-management-system to RepoSync request.
if sRef.Namespace == configsync.ControllerNamespace {
// Ignore secrets in the config-management-system namespace that don't start with ns-reconciler.
if !strings.HasPrefix(sRef.Name, core.NsReconcilerPrefix) {
return nil
}
if err := r.addTypeInformationToObject(secret); err != nil {
klog.Errorf("Failed to add type to object (%s): %v", sRef, err)
return nil
}
allRepoSyncs := &v1beta1.RepoSyncList{}
if err := r.client.List(ctx, allRepoSyncs); err != nil {
klog.Errorf("RepoSync list failed for Secret (%s): %v", sRef, err)
return nil
}
for _, rs := range allRepoSyncs.Items {
// It is a one-to-one mapping between the copied ns-reconciler Secret and the RepoSync object,
// so requeue the mapped RepoSync object and then return.
reconcilerName := core.NsReconcilerName(rs.GetNamespace(), rs.GetName())
if isUpsertedSecret(&rs, sRef.Name) {
return requeueRepoSyncRequest(secret, client.ObjectKeyFromObject(&rs))
}
isSAToken := strings.HasPrefix(sRef.Name, reconcilerName+"-token-")
if isSAToken {
saRef := client.ObjectKey{
Name: reconcilerName,
Namespace: configsync.ControllerNamespace,
}
serviceAccount := &corev1.ServiceAccount{}
if err := r.client.Get(ctx, saRef, serviceAccount); err != nil {
klog.Errorf("ServiceAccount get failed (%s): %v", saRef, err)
return nil
}
for _, s := range serviceAccount.Secrets {
if s.Name == sRef.Name {
return requeueRepoSyncRequest(secret, client.ObjectKeyFromObject(&rs))
}
}
}
}
return nil
}
// map the user-managed ns-reconciler Secret in the RepoSync's namespace to RepoSync request.
// The user-managed ns-reconciler Secret might be shared among multiple RepoSync objects in the same namespace,
// so requeue all the attached RepoSync objects.
attachedRepoSyncs := &v1beta1.RepoSyncList{}
if err := r.client.List(ctx, attachedRepoSyncs, client.InNamespace(sRef.Namespace)); err != nil {
klog.Errorf("RepoSync list failed for Secret (%s): %v", sRef, err)
return nil
}
var requests []reconcile.Request
var attachedRSNames []string
for _, rs := range attachedRepoSyncs.Items {
// Only enqueue a request for the RSync if it references the Secret that triggered the event
switch sRef.Name {
case repoSyncGitSecretName(&rs), repoSyncGitCACertSecretName(&rs),
repoSyncOCICACertSecretName(&rs), repoSyncHelmCACertSecretName(&rs),
repoSyncHelmSecretName(&rs):
attachedRSNames = append(attachedRSNames, rs.GetName())
requests = append(requests, reconcile.Request{
NamespacedName: client.ObjectKeyFromObject(&rs),
})
}
}
if len(requests) > 0 {
klog.Infof("Changes to Secret (%s) triggers a reconciliation for the RepoSync object %q in the same namespace.",
sRef, strings.Join(attachedRSNames, ", "))
}
return requests
}
func (r *RepoSyncReconciler) mapAdmissionWebhookToRepoSyncs(_ context.Context, admissionWebhook client.Object) []reconcile.Request {
if admissionWebhook.GetName() == webhookconfiguration.Name {
return r.requeueAllRepoSyncs(admissionWebhook.GetName())
}
return nil
}
func repoSyncGitSecretName(rs *v1beta1.RepoSync) string {
if rs == nil {
return ""
}
if rs.Spec.Git == nil {
return ""
}
if rs.Spec.Git.SecretRef == nil {
return ""
}
return rs.Spec.Git.SecretRef.Name
}
func repoSyncGitCACertSecretName(rs *v1beta1.RepoSync) string {
if rs == nil {
return ""
}
if rs.Spec.Git == nil {
return ""
}
if rs.Spec.Git.CACertSecretRef == nil {
return ""
}
return rs.Spec.Git.CACertSecretRef.Name
}
func repoSyncOCICACertSecretName(rs *v1beta1.RepoSync) string {
if rs == nil {
return ""
}
if rs.Spec.Oci == nil {
return ""
}
if rs.Spec.Oci.CACertSecretRef == nil {
return ""
}
return rs.Spec.Oci.CACertSecretRef.Name
}
func repoSyncHelmCACertSecretName(rs *v1beta1.RepoSync) string {
if rs == nil {
return ""
}
if rs.Spec.Helm == nil {
return ""
}
if rs.Spec.Helm.CACertSecretRef == nil {
return ""
}
return rs.Spec.Helm.CACertSecretRef.Name
}
func repoSyncHelmSecretName(rs *v1beta1.RepoSync) string {
if rs == nil {
return ""
}
if rs.Spec.Helm == nil {
return ""
}
if rs.Spec.Helm.SecretRef == nil {
return ""
}
return rs.Spec.Helm.SecretRef.Name
}
func (r *RepoSyncReconciler) mapConfigMapToRepoSyncs(ctx context.Context, obj client.Object) []reconcile.Request {
objRef := client.ObjectKeyFromObject(obj)
// Use annotations/labels to map ConfigMap copies in config-management-system
if objRef.Namespace == configsync.ControllerNamespace {
rsRef := types.NamespacedName{}
labels := obj.GetLabels()
if labels != nil {
rsRef.Name = labels[metadata.SyncNameLabel]
rsRef.Namespace = labels[metadata.SyncNamespaceLabel]
}
// fallback to annotations, if labels not set
// TODO: Eventually remove the annotations and use the labels for list filtering, to optimize cleanup.
// We can't remove the annotations until v1.16.0 is no longer supported.
annotations := obj.GetAnnotations()
if annotations != nil {
if len(rsRef.Name) == 0 {
rsRef.Name = annotations[repoSyncNameAnnotationKey]
}
if len(rsRef.Namespace) == 0 {
rsRef.Namespace = annotations[repoSyncNamespaceAnnotationKey]
}
}
if len(rsRef.Name) > 0 && len(rsRef.Namespace) > 0 {
return requeueRepoSyncRequest(obj, rsRef)
}
return nil
}
// For other namespaces, look up RepoSyncs in the same namespace and see
// if any of them reference this ConfigMap.
repoSyncList := &v1beta1.RepoSyncList{}
if err := r.client.List(ctx, repoSyncList, client.InNamespace(objRef.Namespace)); err != nil {
klog.Errorf("failed to list RepoSyncs for %s (%s): %v",
obj.GetObjectKind().GroupVersionKind().Kind, objRef, err)
return nil
}
var requests []reconcile.Request
var attachedRSNames []string
for _, rs := range repoSyncList.Items {
// Only enqueue a request for the RSync if it references the ConfigMap that triggered the event
//TODO: Use stdlib slices.Contains in Go 1.21+
if slices.Contains(repoSyncHelmValuesFileNames(&rs), objRef.Name) {
requests = append(requests, reconcile.Request{
NamespacedName: client.ObjectKeyFromObject(&rs),
})
attachedRSNames = append(attachedRSNames, rs.GetName())
}
}
if len(requests) > 0 {
klog.Infof("Changes to %s triggered a reconciliation for the RepoSync(s) (%s)",
kinds.ObjectSummary(obj), strings.Join(attachedRSNames, ", "))
}
return requests
}
func repoSyncHelmValuesFileNames(rs *v1beta1.RepoSync) []string {
if rs == nil {
return nil
}
if rs.Spec.Helm == nil {
return nil
}
if rs.Spec.Helm.ValuesFileRefs == nil {
return nil
}
names := make([]string, len(rs.Spec.Helm.ValuesFileRefs))
for i, ref := range rs.Spec.Helm.ValuesFileRefs {
names[i] = ref.Name
}
return names
}
// mapObjectToRepoSync define a mapping from an object in 'config-management-system'
// namespace to a RepoSync to be reconciled.
func (r *RepoSyncReconciler) mapObjectToRepoSync(ctx context.Context, obj client.Object) []reconcile.Request {
objRef := client.ObjectKeyFromObject(obj)
// Ignore changes from resources without the ns-reconciler prefix or configsync.gke.io:ns-reconciler
// because all the generated resources have the prefix.
nsRoleBindingName := RepoSyncBaseRoleBindingName
if !strings.HasPrefix(objRef.Name, core.NsReconcilerPrefix) && objRef.Name != nsRoleBindingName {
return nil
}
if err := r.addTypeInformationToObject(obj); err != nil {
klog.Errorf("failed to lookup resource of object %T (%s): %v",
obj, objRef, err)
return nil
}
if objRef.Namespace != configsync.ControllerNamespace {
switch obj.(type) {
case *corev1.ServiceAccount, *appsv1.Deployment:
// All Deployments and ServiceAccounts are in config-management-system
return nil
}
}
allRepoSyncs := &v1beta1.RepoSyncList{}
if err := r.client.List(ctx, allRepoSyncs); err != nil {
klog.Errorf("failed to list all RepoSyncs for %s (%s): %v",
obj.GetObjectKind().GroupVersionKind().Kind, objRef, err)
return nil
}
// Most of the resources are mapped to a single RepoSync object except RoleBinding.
// All RepoSync objects share the same RoleBinding object, so requeue all RepoSync objects if the RoleBinding is changed.
// For other resources, requeue the mapping RepoSync object and then return.
var requests []reconcile.Request
var attachedRSNames []string
for _, rs := range allRepoSyncs.Items {
reconcilerName := core.NsReconcilerName(rs.GetNamespace(), rs.GetName())
switch obj.(type) {
case *rbacv1.RoleBinding:
if objRef.Name == nsRoleBindingName && objRef.Namespace == rs.Namespace {
requests = append(requests, reconcile.Request{
NamespacedName: client.ObjectKeyFromObject(&rs),
})
attachedRSNames = append(attachedRSNames, rs.GetName())
}
default: // Deployment and ServiceAccount
if objRef.Name == reconcilerName {
return requeueRepoSyncRequest(obj, client.ObjectKeyFromObject(&rs))
}
}
}
if len(requests) > 0 {
klog.Infof("Changes to %s (%s) triggers a reconciliation for the RepoSync(s) (%s)",
obj.GetObjectKind().GroupVersionKind().Kind, objRef, strings.Join(attachedRSNames, ", "))
}
return requests
}
func requeueRepoSyncRequest(obj client.Object, rsRef types.NamespacedName) []reconcile.Request {
klog.Infof("Changes to %s triggered a reconciliation for the RepoSync (%s).",
kinds.ObjectSummary(obj), rsRef)
return []reconcile.Request{
{
NamespacedName: rsRef,
},
}
}
func (r *RepoSyncReconciler) populateContainerEnvs(ctx context.Context, rs *v1beta1.RepoSync, reconcilerName string) map[string][]corev1.EnvVar {
result := map[string][]corev1.EnvVar{
reconcilermanager.HydrationController: hydrationEnvs(hydrationOptions{
sourceType: rs.Spec.SourceType,
gitConfig: rs.Spec.Git,
ociConfig: rs.Spec.Oci,
scope: declared.Scope(rs.Namespace),
reconcilerName: reconcilerName,
pollPeriod: r.hydrationPollingPeriod.String(),
}),
reconcilermanager.Reconciler: reconcilerEnvs(reconcilerOptions{
clusterName: r.clusterName,
syncName: rs.Name,
syncGeneration: rs.Generation,
reconcilerName: reconcilerName,
reconcilerScope: declared.Scope(rs.Namespace),
sourceType: rs.Spec.SourceType,
gitConfig: rs.Spec.Git,
ociConfig: rs.Spec.Oci,
helmConfig: reposync.GetHelmBase(rs.Spec.Helm),
pollPeriod: r.reconcilerPollingPeriod.String(),
statusMode: rs.Spec.SafeOverride().StatusMode,
reconcileTimeout: v1beta1.GetReconcileTimeout(rs.Spec.SafeOverride().ReconcileTimeout),
apiServerTimeout: v1beta1.GetAPIServerTimeout(rs.Spec.SafeOverride().APIServerTimeout),
requiresRendering: annotationEnabled(metadata.RequiresRenderingAnnotationKey, rs.GetAnnotations()),
// Namespace reconciler doesn't support NamespaceSelector at all.
dynamicNSSelectorEnabled: false,
webhookEnabled: r.webhookEnabled,
}),
}
switch rs.Spec.SourceType {
case configsync.GitSource:
result[reconcilermanager.GitSync] = gitSyncEnvs(ctx, options{
ref: rs.Spec.Git.Revision,
branch: rs.Spec.Git.Branch,
repo: rs.Spec.Git.Repo,
secretType: rs.Spec.Git.Auth,
period: v1beta1.GetPeriod(rs.Spec.Git.Period, configsync.DefaultReconcilerPollingPeriod),
proxy: rs.Spec.Proxy,
depth: rs.Spec.SafeOverride().GitSyncDepth,
noSSLVerify: rs.Spec.Git.NoSSLVerify,
caCertSecretRef: v1beta1.GetSecretName(rs.Spec.Git.CACertSecretRef),
knownHost: r.isKnownHostsEnabled(rs.Spec.Git.Auth),
})
if EnableAskpassSidecar(rs.Spec.SourceType, rs.Spec.Git.Auth) {
result[reconcilermanager.GCENodeAskpassSidecar] = gceNodeAskPassSidecarEnvs(rs.Spec.GCPServiceAccountEmail)
}
case configsync.OciSource:
result[reconcilermanager.OciSync] = ociSyncEnvs(ociOptions{
image: rs.Spec.Oci.Image,
auth: rs.Spec.Oci.Auth,
period: v1beta1.GetPeriod(rs.Spec.Oci.Period, configsync.DefaultReconcilerPollingPeriod).Seconds(),
caCertSecretRef: v1beta1.GetSecretName(rs.Spec.Oci.CACertSecretRef),
})
case configsync.HelmSource:
result[reconcilermanager.HelmSync] = helmSyncEnvs(helmOptions{
helmBase: &rs.Spec.Helm.HelmBase,
releaseNamespace: rs.Namespace,
// RepoSync API doesn't support specifying deployNamespace
deployNamespace: "",
caCertSecretRef: v1beta1.GetSecretName(rs.Spec.Helm.CACertSecretRef),
})
}
return result
}
func (r *RepoSyncReconciler) validateRepoSync(ctx context.Context, rs *v1beta1.RepoSync, reconcilerName string) error {
if rs.Namespace == configsync.ControllerNamespace {
return fmt.Errorf("RepoSync objects are not allowed in the %s namespace", configsync.ControllerNamespace)
}
if err := validation.IsDNS1123Subdomain(reconcilerName); err != nil {
return fmt.Errorf("Invalid reconciler name %q: %s.", reconcilerName, strings.Join(err, ", "))
}
if err := r.validateSourceSpec(ctx, rs, reconcilerName); err != nil {
return err
}
return r.validateValuesFileSourcesRefs(ctx, rs)
}
func (r *RepoSyncReconciler) validateSourceSpec(ctx context.Context, rs *v1beta1.RepoSync, reconcilerName string) error {
switch rs.Spec.SourceType {
case configsync.GitSource:
return r.validateGitSpec(ctx, rs, reconcilerName)
case configsync.OciSource:
return r.validateOciSpec(ctx, rs)
case configsync.HelmSource:
return r.validateHelmSpec(ctx, rs)
default:
return validate.InvalidSourceType(rs)
}
}
// validateValuesFileSourcesRefs validates that the ConfigMaps specified in the RSync ValuesFileSources exist and have the
// specified data key.
func (r *RepoSyncReconciler) validateValuesFileSourcesRefs(ctx context.Context, rs *v1beta1.RepoSync) status.Error {
if rs.Spec.SourceType != configsync.HelmSource || rs.Spec.Helm == nil || len(rs.Spec.Helm.ValuesFileRefs) == 0 {
return nil
}