/
controller.go
1336 lines (1195 loc) · 45.2 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
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 2018 The Kubernetes Authors.
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.
This file may have been modified by The KubeAdmiral Authors
("KubeAdmiral Modifications"). All KubeAdmiral Modifications
are Copyright 2023 The KubeAdmiral Authors.
*/
package sync
import (
"context"
"fmt"
"strings"
"sync"
"time"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
pkgruntime "k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
fedcorev1a1 "github.com/kubewharf/kubeadmiral/pkg/apis/core/v1alpha1"
fedclient "github.com/kubewharf/kubeadmiral/pkg/client/clientset/versioned"
fedcorev1a1informers "github.com/kubewharf/kubeadmiral/pkg/client/informers/externalversions/core/v1alpha1"
"github.com/kubewharf/kubeadmiral/pkg/controllers/common"
"github.com/kubewharf/kubeadmiral/pkg/controllers/sync/dispatch"
"github.com/kubewharf/kubeadmiral/pkg/controllers/sync/status"
"github.com/kubewharf/kubeadmiral/pkg/controllers/util"
"github.com/kubewharf/kubeadmiral/pkg/stats"
"github.com/kubewharf/kubeadmiral/pkg/stats/metrics"
"github.com/kubewharf/kubeadmiral/pkg/util/adoption"
"github.com/kubewharf/kubeadmiral/pkg/util/cascadingdeletion"
clusterutil "github.com/kubewharf/kubeadmiral/pkg/util/cluster"
"github.com/kubewharf/kubeadmiral/pkg/util/eventhandlers"
"github.com/kubewharf/kubeadmiral/pkg/util/eventsink"
"github.com/kubewharf/kubeadmiral/pkg/util/fedobjectadapters"
finalizersutil "github.com/kubewharf/kubeadmiral/pkg/util/finalizers"
"github.com/kubewharf/kubeadmiral/pkg/util/informermanager"
"github.com/kubewharf/kubeadmiral/pkg/util/logging"
"github.com/kubewharf/kubeadmiral/pkg/util/managedlabel"
"github.com/kubewharf/kubeadmiral/pkg/util/naming"
"github.com/kubewharf/kubeadmiral/pkg/util/orphaning"
"github.com/kubewharf/kubeadmiral/pkg/util/pendingcontrollers"
"github.com/kubewharf/kubeadmiral/pkg/util/worker"
)
const (
SyncControllerName = "sync-controller"
)
const (
EventReasonWaitForCascadingDelete = "WaitForCascadingDelete"
EventReasonWaitForCascadingDeleteError = "WaitForCascadingDeleteError"
)
const (
// If this finalizer is present on a federated resource, the sync
// controller will have the opportunity to perform pre-deletion operations
// (like deleting managed resources from member clusters).
FinalizerSyncController = common.DefaultPrefix + "sync-controller"
// If this finalizer is present on a cluster, the sync
// controller will have the opportunity to perform per-deletion operations
// (like deleting managed resources from member clusters).
FinalizerCascadingDelete = common.DefaultPrefix + "cascading-delete"
)
// SyncController synchronizes the state of federated resources
// in the host cluster with resources in member clusters.
type SyncController struct {
worker worker.ReconcileWorker[common.QualifiedName]
// For handling cascading deletion.
clusterCascadingDeletionWorker worker.ReconcileWorker[common.QualifiedName]
// For triggering reconciliation of all target resources.
reconcileAllResourcesQueue workqueue.DelayingInterface
fedClient fedclient.Interface
ftcManager informermanager.FederatedTypeConfigManager
fedInformerManager informermanager.FederatedInformerManager
// For accessing FederatedResources (logical federated objects)
fedAccessor FederatedResourceAccessor
// For events
eventRecorder record.EventRecorder
clusterAvailableDelay time.Duration
clusterUnavailableDelay time.Duration
reconcileOnClusterChangeDelay time.Duration
reconcileOnFTCChangeDelay time.Duration
memberObjectEnqueueDelay time.Duration
recheckAfterDispatchDelay time.Duration
ensureDeletionRecheckDelay time.Duration
cascadingDeletionRecheckDelay time.Duration
metrics stats.Metrics
logger klog.Logger
}
// NewSyncController returns a new sync controller for the configuration
func NewSyncController(
kubeClient kubernetes.Interface,
fedClient fedclient.Interface,
fedObjectInformer fedcorev1a1informers.FederatedObjectInformer,
clusterFedObjectInformer fedcorev1a1informers.ClusterFederatedObjectInformer,
ftcManager informermanager.FederatedTypeConfigManager,
fedInformerManager informermanager.FederatedInformerManager,
fedSystemNamespace, targetNamespace string,
clusterAvailableDelay, clusterUnavailableDelay, memberObjectEnqueueDelay time.Duration,
logger klog.Logger,
syncWorkerCount int,
cascadingDeletionWorkerCount int,
metrics stats.Metrics,
) (*SyncController, error) {
recorder := eventsink.NewDefederatingRecorderMux(kubeClient, SyncControllerName, 4)
logger = klog.LoggerWithValues(logger, "controller", SyncControllerName)
s := &SyncController{
fedClient: fedClient,
ftcManager: ftcManager,
fedInformerManager: fedInformerManager,
clusterAvailableDelay: clusterAvailableDelay,
clusterUnavailableDelay: clusterUnavailableDelay,
reconcileOnClusterChangeDelay: time.Second * 3,
reconcileOnFTCChangeDelay: time.Second * 3,
memberObjectEnqueueDelay: memberObjectEnqueueDelay,
recheckAfterDispatchDelay: time.Second * 10,
ensureDeletionRecheckDelay: time.Second * 5,
cascadingDeletionRecheckDelay: time.Second * 10,
eventRecorder: recorder,
metrics: metrics,
logger: logger,
}
s.worker = worker.NewReconcileWorker[common.QualifiedName](
SyncControllerName,
s.reconcile,
worker.RateLimiterOptions{},
syncWorkerCount,
metrics,
)
s.clusterCascadingDeletionWorker = worker.NewReconcileWorker[common.QualifiedName](
SyncControllerName+"-cluster-cascading-deletion-worker",
s.reconcileClusterForCascadingDeletion,
worker.RateLimiterOptions{},
cascadingDeletionWorkerCount,
metrics,
)
// Build queue for triggering reconciliation of all federated resources..
s.reconcileAllResourcesQueue = workqueue.NewNamedDelayingQueue(
SyncControllerName + "-reconcile-all-resources-queue",
)
if err := s.ftcManager.AddFTCUpdateHandler(func(lastObserved, latest *fedcorev1a1.FederatedTypeConfig) {
isNewFTC := lastObserved == nil && latest != nil
ftcPathDefinitionsChanged := lastObserved != nil && latest != nil && lastObserved.Spec.PathDefinition != latest.Spec.PathDefinition
if isNewFTC || ftcPathDefinitionsChanged {
s.enqueueForGVK(latest.GetSourceTypeGVK())
}
}); err != nil {
return nil, fmt.Errorf("failed to add FTC update handler: %w", err)
}
if err := s.fedInformerManager.AddEventHandlerGenerator(&informermanager.EventHandlerGenerator{
Predicate: informermanager.RegisterOncePredicate,
Generator: func(ftc *fedcorev1a1.FederatedTypeConfig) cache.ResourceEventHandler {
return eventhandlers.NewTriggerOnAllChanges(func(o pkgruntime.Object) {
obj := o.(*unstructured.Unstructured)
ftc, exists := s.ftcManager.GetResourceFTC(obj.GroupVersionKind())
if !exists {
return
}
federatedName := common.QualifiedName{
Namespace: obj.GetNamespace(),
Name: naming.GenerateFederatedObjectName(obj.GetName(), ftc.GetName()),
}
s.worker.EnqueueWithDelay(federatedName, s.memberObjectEnqueueDelay)
})
},
}); err != nil {
return nil, fmt.Errorf("failed to add event handler generator: %w", err)
}
if err := s.fedInformerManager.AddClusterEventHandlers(
&informermanager.ClusterEventHandler{
Predicate: func(oldCluster, newCluster *fedcorev1a1.FederatedCluster) bool {
// Enqueue cluster when it's added or marked for deletion to ensure cascading deletion
return oldCluster == nil || newCluster != nil && oldCluster.GetDeletionTimestamp().IsZero() &&
!newCluster.GetDeletionTimestamp().IsZero()
},
Callback: func(cluster *fedcorev1a1.FederatedCluster) {
s.clusterCascadingDeletionWorker.Enqueue(common.NewQualifiedName(cluster))
},
},
&informermanager.ClusterEventHandler{
Predicate: func(oldCluster, newCluster *fedcorev1a1.FederatedCluster) bool {
// Reconcile all federated objects when cluster becomes ready
newClusterIsReady := newCluster != nil && clusterutil.IsClusterReady(&newCluster.Status)
oldClusterIsUnready := oldCluster == nil || !clusterutil.IsClusterReady(&oldCluster.Status)
return newClusterIsReady && oldClusterIsUnready
},
Callback: func(cluster *fedcorev1a1.FederatedCluster) {
s.reconcileAllResourcesQueue.AddAfter(struct{}{}, s.clusterAvailableDelay)
},
},
&informermanager.ClusterEventHandler{
Predicate: func(oldCluster, newCluster *fedcorev1a1.FederatedCluster) bool {
// Reconcile all federated objects when cluster becomes unready
if newCluster == nil {
// When the cluster is deleted
return true
}
if clusterutil.IsClusterReady(&newCluster.Status) {
return false
}
return oldCluster != nil && clusterutil.IsClusterReady(&oldCluster.Status)
},
Callback: func(cluster *fedcorev1a1.FederatedCluster) {
s.reconcileAllResourcesQueue.AddAfter(struct{}{}, s.clusterUnavailableDelay)
},
},
&informermanager.ClusterEventHandler{
Predicate: func(oldCluster, newCluster *fedcorev1a1.FederatedCluster) bool {
// Trigger cascading deletion when cluster is marked for deletion
return newCluster != nil && !newCluster.GetDeletionTimestamp().IsZero() &&
(oldCluster == nil || oldCluster.GetDeletionTimestamp().IsZero())
},
Callback: func(cluster *fedcorev1a1.FederatedCluster) {
s.reconcileAllResourcesQueue.Add(struct{}{})
},
},
); err != nil {
return nil, fmt.Errorf("failed to add cluster event handler: %w", err)
}
s.fedAccessor = NewFederatedResourceAccessor(
logger,
fedSystemNamespace, targetNamespace,
fedClient.CoreV1alpha1(),
fedObjectInformer, clusterFedObjectInformer,
ftcManager,
func(qualifiedName common.QualifiedName) {
s.worker.Enqueue(qualifiedName)
},
recorder,
)
return s, nil
}
func (s *SyncController) Run(ctx context.Context) {
s.fedAccessor.Run(ctx)
go func() {
for {
item, shutdown := s.reconcileAllResourcesQueue.Get()
if shutdown {
break
}
s.enqueueAllObjects()
s.reconcileAllResourcesQueue.Done(item)
}
}()
if !cache.WaitForNamedCacheSync(SyncControllerName, ctx.Done(), s.HasSynced) {
s.logger.Error(nil, "Timed out waiting for cache sync")
return
}
s.logger.Info("Caches are synced")
s.worker.Run(ctx)
s.clusterCascadingDeletionWorker.Run(ctx)
// Ensure all goroutines are cleaned up when the stop channel closes
go func() {
<-ctx.Done()
s.reconcileAllResourcesQueue.ShutDown()
}()
}
// Check whether all data stores are in sync. False is returned if any of the informer/stores is not yet
// synced with the corresponding api server.
func (s *SyncController) HasSynced() bool {
if !s.ftcManager.HasSynced() {
s.logger.V(3).Info("FederatedTypeConfigManager not synced")
return false
}
if !s.fedInformerManager.HasSynced() {
s.logger.V(3).Info("FederatedInformerManager not synced")
return false
}
if !s.fedAccessor.HasSynced() {
// The fed accessor will have logged why sync is not yet
// complete.
return false
}
return true
}
func (s *SyncController) IsControllerReady() bool {
return s.HasSynced()
}
func (s *SyncController) getClusterClient(clusterName string) (dynamic.Interface, error) {
if client, exists := s.fedInformerManager.GetClusterDynamicClient(clusterName); exists {
return client, nil
}
return nil, fmt.Errorf("client does not exist for cluster")
}
// Triggers reconciliation of all target federated resources.
func (s *SyncController) enqueueAllObjects() {
s.logger.V(2).Info("Enqueuing all federated resources")
s.fedAccessor.VisitFederatedResources(func(obj fedcorev1a1.GenericFederatedObject) {
qualifiedName := common.NewQualifiedName(obj)
s.worker.EnqueueWithDelay(qualifiedName, s.reconcileOnClusterChangeDelay)
})
}
// Triggers reconciliation of all target federated resources of the given gvk.
func (s *SyncController) enqueueForGVK(gvk schema.GroupVersionKind) {
s.logger.V(2).Info("Enqueuing federated resources for gvk", "gvk", gvk.String())
s.fedAccessor.VisitFederatedResources(func(obj fedcorev1a1.GenericFederatedObject) {
templateMeta, err := obj.GetSpec().GetTemplateMetadata()
if err != nil {
s.logger.Error(err, "failed to get template metadata")
return
}
if templateMeta.GroupVersionKind() == gvk {
qualifiedName := common.NewQualifiedName(obj)
s.worker.EnqueueWithDelay(qualifiedName, s.reconcileOnFTCChangeDelay)
}
})
}
func (s *SyncController) reconcile(ctx context.Context, federatedName common.QualifiedName) (status worker.Result) {
ctx, keyedLogger := logging.InjectLogger(ctx, s.logger.WithValues("federated-name", federatedName.String()))
fedResource, err := s.fedAccessor.FederatedResource(federatedName)
if err != nil {
keyedLogger.Error(err, "Failed to create FederatedResource helper")
return worker.StatusError
}
if fedResource == nil {
return worker.StatusAllOK
}
ctx, keyedLogger = logging.InjectLoggerValues(
ctx,
"target-name", fedResource.TargetName().String(),
"gvk", fedResource.TargetGVK().String(),
)
s.metrics.Counter(metrics.SyncThroughput, 1)
keyedLogger.V(3).Info("Starting to reconcile")
startTime := time.Now()
defer func() {
s.metrics.Duration(metrics.SyncLatency, startTime)
keyedLogger.WithValues("duration", time.Since(startTime), "status", status.String()).
V(3).
Info("Finished reconciling")
}()
if fedResource.Object().GetDeletionTimestamp() != nil {
return s.handleTerminatingFederatedResource(ctx, fedResource)
}
pendingControllers, err := pendingcontrollers.GetPendingControllers(fedResource.Object())
if err != nil {
keyedLogger.Error(err, "Failed to get pending controllers")
return worker.StatusError
}
isCentralizedHPAObject, err := isCentralizedHPAObject(ctx, fedResource.Object())
if err != nil {
return worker.StatusError
}
if len(pendingControllers) > 0 && !isCentralizedHPAObject {
// upstream controllers have not finished processing, we wait for our turn
return worker.StatusAllOK
}
err = s.ensureFinalizer(ctx, fedResource)
if err != nil {
if apierrors.IsConflict(err) {
return worker.StatusConflict
}
fedResource.RecordError("EnsureFinalizerError", errors.Wrap(err, "Failed to ensure finalizer"))
return worker.StatusError
}
if fedResource.Object().GetAnnotations()[common.DryRunAnnotation] == common.AnnotationValueTrue {
if len(fedResource.Object().GetStatus().Clusters) == 0 {
fedResource.RecordEvent("DryRunWorked", "Dry run worked for %s", fedResource.FederatedName())
return worker.StatusAllOK
}
fedResource.RecordEvent("DryRunSkipped", "Dry run skipped because resource has been propagated")
}
clustersToSync, selectedClusters, err := s.prepareToSync(ctx, fedResource, isCentralizedHPAObject)
if err != nil {
fedResource.RecordError("PrepareToSyncError", errors.Wrap(err, "Failed to prepare to sync"))
return worker.StatusError
}
return s.syncToClusters(ctx, fedResource, clustersToSync, selectedClusters)
}
// prepareToSync performs the following preprocessing steps required to sync federated objects to selected member clusters:
// 1. Compute the list of selected member clusters from the placement field.
// 2. Compute the list of member clusters that requires an operation to be dispatched.
// 3. For newly selected clusters, update the PropagationStatus for these clusters to PendingCreate.
//
// The PendingCreate status allows us to safely skip checking of clusters during object deletion when PropagationStatus is
// empty. If not, it might be that the object was created but we failed to update the federated object's status previously.
func (s *SyncController) prepareToSync(
ctx context.Context,
fedResource FederatedResource,
isCentralizedHPAObject bool,
) (
requireSync []*fedcorev1a1.FederatedCluster,
selectedClusters sets.Set[string],
err error,
) {
keyedLogger := klog.FromContext(ctx)
clusters, err := s.fedInformerManager.GetJoinedClusters()
if err != nil {
fedResource.RecordError(
string(fedcorev1a1.ClusterRetrievalFailed),
errors.Wrap(err, "Failed to retrieve list of clusters"),
)
result := s.setFederatedStatus(ctx, fedResource, fedcorev1a1.ClusterRetrievalFailed, nil)
if result != worker.StatusAllOK {
keyedLogger.Error(nil, "Failed to set federated status", "result", result.String())
}
return nil, nil, err
}
clusterMap := make(map[string]*fedcorev1a1.FederatedCluster, len(clusters))
for _, cluster := range clusters {
clusterMap[cluster.Name] = cluster
}
selectedClusterNames := fedResource.ComputePlacement(clusters)
if isCentralizedHPAObject {
selectedClusterNames = nil
}
pendingCreateClusters := selectedClusterNames.Clone()
status := fedResource.Object().GetStatus()
for _, cluster := range status.Clusters {
pendingCreateClusters.Delete(cluster.Cluster)
if cluster, exist := clusterMap[cluster.Cluster]; exist {
requireSync = append(requireSync, cluster)
}
}
if pendingCreateClusters.Len() == 0 {
return requireSync, selectedClusterNames, nil
}
for cluster := range pendingCreateClusters {
if cluster, exist := clusterMap[cluster]; exist && cluster.GetDeletionTimestamp().IsZero() {
status.Clusters = append(status.Clusters, fedcorev1a1.PropagationStatus{
Cluster: cluster.Name,
Status: fedcorev1a1.PendingCreate,
})
requireSync = append(requireSync, cluster)
}
}
keyedLogger.V(1).Info("Update clusters pending object creation",
"clusters", strings.Join(sets.List(pendingCreateClusters), ","))
obj := fedResource.Object()
objNamespace := obj.GetNamespace()
objName := obj.GetName()
// If the underlying resource has changed, attempt to retrieve and
// update it repeatedly.
err = wait.PollImmediateWithContext(ctx, 1*time.Second, 5*time.Second, func(ctx context.Context) (bool, error) {
var err error
obj.GetStatus().Clusters = status.Clusters
obj, err = fedobjectadapters.UpdateStatus(ctx, s.fedClient.CoreV1alpha1(), obj, metav1.UpdateOptions{})
if err == nil {
fedResource.SetObject(obj)
return true, nil
}
if apierrors.IsConflict(err) {
obj, err = fedobjectadapters.Get(
ctx,
s.fedClient.CoreV1alpha1(),
objNamespace,
objName,
metav1.GetOptions{},
)
if err != nil {
return false, errors.Wrapf(err, "failed to retrieve resource")
}
return false, nil
}
return false, errors.Wrapf(err, "failed to update resource")
})
if err != nil {
keyedLogger.Error(err, "Failed to set propagation status")
return nil, nil, err
}
return requireSync, selectedClusterNames, nil
}
// syncToClusters ensures that the state of the given object is
// synchronized to member clusters.
func (s *SyncController) syncToClusters(
ctx context.Context,
fedResource FederatedResource,
clusters []*fedcorev1a1.FederatedCluster,
selectedClusterNames sets.Set[string],
) worker.Result {
keyedLogger := klog.FromContext(ctx)
var err error
keyedLogger.V(2).
Info("Ensuring target object in clusters", "clusters", strings.Join(sets.List(selectedClusterNames), ","))
skipAdoptingPreexistingResources := !adoption.ShouldAdoptPreexistingResources(fedResource.Object())
dispatcher := dispatch.NewManagedDispatcher(
s.getClusterClient,
fedResource,
skipAdoptingPreexistingResources,
s.metrics,
)
shouldRecheckAfterDispatch := false
for _, cluster := range clusters {
clusterName := cluster.Name
shouldBeDeleted := !selectedClusterNames.Has(clusterName)
isCascadingDeletionTriggered := cluster.GetDeletionTimestamp() != nil &&
cascadingdeletion.IsCascadingDeleteEnabled(cluster)
if !clusterutil.IsClusterReady(&cluster.Status) {
if !shouldBeDeleted {
// Cluster state only needs to be reported in resource
// status for clusters where the object should not be deleted.
err := errors.New("Cluster not ready")
dispatcher.RecordClusterError(fedcorev1a1.ClusterNotReady, clusterName, err)
}
continue
}
var clusterObj *unstructured.Unstructured
{
clusterObj, _, err = informermanager.GetClusterObject(
ctx,
s.ftcManager,
s.fedInformerManager,
clusterName,
fedResource.TargetName(),
fedResource.TargetGVK(),
)
if err != nil {
wrappedErr := fmt.Errorf("failed to get cluster object: %w", err)
dispatcher.RecordClusterError(fedcorev1a1.CachedRetrievalFailed, clusterName, wrappedErr)
continue
}
}
if clusterObj != nil {
// If one of fedObject and clusterObj is a derived service and the other is not,
// the obtained clusterObj does not correspond to fedObj and should be set to nil.
if util.IsDerivedService(fedResource.Object().GetAnnotations()) != util.IsDerivedService(clusterObj.GetAnnotations()) {
clusterObj = nil
}
}
// If cascading deletion is triggered, wait for reconcileClusterForCascadingDeletion to perform the deletion operation.
// If the delete operation has not been performed, federatedObject's status will be updated to WaitingForCascadingDeletion.
if isCascadingDeletionTriggered {
if clusterObj != nil && clusterObj.GetDeletionTimestamp() == nil {
dispatcher.RecordStatus(clusterName, fedcorev1a1.WaitingForCascadingDeletion)
}
continue
}
// Resource should not exist in the named cluster
if shouldBeDeleted {
if clusterObj == nil {
// Resource does not exist in the cluster
continue
}
if clusterObj.GetDeletionTimestamp() != nil {
// Resource is marked for deletion
dispatcher.RecordStatus(clusterName, fedcorev1a1.WaitingForRemoval)
continue
}
if cluster.GetDeletionTimestamp() != nil && !cascadingdeletion.IsCascadingDeleteEnabled(cluster) {
// If cluster is terminating and cascading-delete is disabled,
// disallow deletion to preserve cluster object.
// This could happen right after a cluster is deleted:
// the scheduler observes the cluster deletion and removes
// the placement, while the sync controller's informer is
// lagging behind and observes a terminating cluster.
continue
}
// We only respect orphaning behavior during cascading deletion, but not while migrating between clusters.
s.removeFromCluster(ctx, dispatcher, clusterName, fedResource, clusterObj, isCascadingDeletionTriggered)
continue
}
// Resource should appear in the named cluster
if cluster.GetDeletionTimestamp() != nil {
// if the cluster is terminating, we should not sync
dispatcher.RecordClusterError(
fedcorev1a1.ClusterTerminating,
clusterName,
errors.New("Cluster terminating"),
)
continue
}
hasFinalizer := finalizersutil.HasFinalizer(cluster, FinalizerCascadingDelete)
if !hasFinalizer {
// we should not sync before finalizer is added
shouldRecheckAfterDispatch = true
dispatcher.RecordClusterError(
fedcorev1a1.FinalizerCheckFailed,
clusterName,
errors.Errorf("Missing cluster finalizer %s", FinalizerCascadingDelete),
)
continue
}
if clusterObj == nil {
dispatcher.Create(ctx, clusterName)
} else {
dispatcher.Update(ctx, clusterName, clusterObj)
}
}
dispatchOk, timeoutErr := dispatcher.Wait()
if !dispatchOk {
keyedLogger.Error(nil, "Failed to sync target object to cluster")
}
if timeoutErr != nil {
fedResource.RecordError("OperationTimeoutError", timeoutErr)
keyedLogger.Error(timeoutErr, "Sync to cluster timeout")
return worker.StatusError
}
// Write updated versions to the API.
updatedVersionMap := dispatcher.VersionMap()
err = fedResource.UpdateVersions(sets.List(selectedClusterNames), updatedVersionMap)
if err != nil {
// Versioning of federated resources is an optimization to
// avoid unnecessary updates, and failure to record version
// information does not indicate a failure of propagation.
keyedLogger.Error(err, "Failed to record version information")
}
collectedStatus := dispatcher.CollectedStatus()
if reconcileStatus := s.setFederatedStatus(
ctx,
fedResource,
fedcorev1a1.AggregateSuccess,
&collectedStatus,
); reconcileStatus != worker.StatusAllOK {
return reconcileStatus
}
if !dispatchOk {
return worker.StatusError
}
if shouldRecheckAfterDispatch {
return worker.Result{RequeueAfter: &s.recheckAfterDispatchDelay}
}
return worker.StatusAllOK
}
func (s *SyncController) setFederatedStatus(
ctx context.Context,
fedResource FederatedResource,
reason fedcorev1a1.FederatedObjectConditionReason,
collectedStatus *status.CollectedPropagationStatus,
) worker.Result {
if collectedStatus == nil {
collectedStatus = &status.CollectedPropagationStatus{}
}
obj := fedResource.Object()
objNamespace := obj.GetNamespace()
objName := obj.GetName()
keyedLogger := klog.FromContext(ctx)
// If the underlying resource has changed, attempt to retrieve and
// update it repeatedly.
err := wait.PollImmediateWithContext(ctx, 1*time.Second, 5*time.Second, func(ctx context.Context) (bool, error) {
if updateRequired := status.SetFederatedStatus(obj, reason, *collectedStatus); !updateRequired {
keyedLogger.V(4).Info("No status update necessary")
return true, nil
}
var err error
obj, err = fedobjectadapters.UpdateStatus(ctx, s.fedClient.CoreV1alpha1(), obj, metav1.UpdateOptions{})
if err == nil {
fedResource.SetObject(obj)
return true, nil
}
if apierrors.IsConflict(err) {
obj, err = fedobjectadapters.Get(
ctx,
s.fedClient.CoreV1alpha1(),
objNamespace,
objName,
metav1.GetOptions{},
)
if err != nil {
return false, errors.Wrapf(err, "failed to retrieve resource")
}
return false, nil
}
return false, errors.Wrapf(err, "failed to update resource")
})
if err != nil {
keyedLogger.Error(err, "Failed to set propagation status")
return worker.StatusError
}
return worker.StatusAllOK
}
func (s *SyncController) handleTerminatingFederatedResource(
ctx context.Context,
fedResource FederatedResource,
) worker.Result {
fedResource.DeleteVersions()
keyedLogger := klog.FromContext(ctx)
keyedLogger.V(2).Info("Ensuring deletion of federated object")
obj := fedResource.Object()
finalizers := sets.NewString(obj.GetFinalizers()...)
if !finalizers.Has(FinalizerSyncController) {
keyedLogger.V(3).
Info("Federated object does not have the finalizer. Nothing to do", "finalizer-name", FinalizerSyncController)
return worker.StatusAllOK
}
keyedLogger.V(2).Info("Deleting resources managed by this federated object from member clusters")
recheckRequired, err := s.ensureRemovalFromClusters(ctx, fedResource)
if err != nil {
fedResource.RecordError(string(fedcorev1a1.EnsureDeletionFailed), err)
keyedLogger.Error(err, "Failed to ensure deletion of member objects")
return worker.StatusError
}
if recheckRequired {
return worker.Result{RequeueAfter: &s.ensureDeletionRecheckDelay}
}
if err := s.removeFinalizer(ctx, fedResource); err != nil {
if apierrors.IsConflict(err) {
return worker.StatusConflict
}
keyedLogger.Error(
err,
"Failed to remove finalizer from the federated object",
"finalizer-name",
FinalizerSyncController,
)
return worker.StatusError
}
return worker.StatusAllOK
}
func (s *SyncController) removeFromCluster(
ctx context.Context,
dispatcher dispatch.UnmanagedDispatcher,
clusterName string,
fedResource FederatedResource,
clusterObj *unstructured.Unstructured,
respectOrphaningBehavior bool,
) {
if !respectOrphaningBehavior {
dispatcher.Delete(ctx, clusterName, clusterObj)
return
}
keyedLogger := klog.FromContext(ctx)
// Respect orphaning behavior
if orphaning.ShouldBeOrphaned(fedResource.Object(), clusterObj) {
keyedLogger.WithValues("cluster-name", clusterName).
V(2).Info("Cluster object is going to be orphaned")
dispatcher.RemoveManagedLabel(ctx, clusterName, clusterObj)
} else {
dispatcher.Delete(ctx, clusterName, clusterObj)
}
}
func (s *SyncController) ensureRemovalFromClusters(ctx context.Context, fedResource FederatedResource) (bool, error) {
keyedLogger := klog.FromContext(ctx)
remainingClusters := []string{}
clustersNoNeedHandleDeletion, ok, err := s.handleDeletionInClusters(
ctx,
fedResource,
func(dispatcher dispatch.UnmanagedDispatcher, clusterName string, clusterObj *unstructured.Unstructured) {
remainingClusters = append(remainingClusters, clusterName)
s.removeFromCluster(ctx, dispatcher, clusterName, fedResource, clusterObj, true)
},
)
if err != nil {
return false, err
}
if !ok {
return false, errors.Errorf("failed to remove managed resources from one or more clusters.")
}
if len(remainingClusters) > 0 {
keyedLogger.WithValues("clusters", strings.Join(remainingClusters, ", ")).
V(2).Info("Waiting for resources managed by this federated object to be removed from some clusters")
return true, nil
}
err = s.checkObjectRemovedFromAllClusters(ctx, fedResource, clustersNoNeedHandleDeletion)
if err != nil {
return false, errors.Wrapf(err, "failed to verify that managed resources no longer exist in any cluster")
}
// Managed resources no longer exist in any member cluster
return false, nil
}
// checkObjectRemovedFromAllClusters checks that no resources in member
// clusters that could be managed by the given federated resources are
// present or labeled as managed. The checks are performed without
// the informer to cover the possibility that the resources have not
// yet been cached.
func (s *SyncController) checkObjectRemovedFromAllClusters(
ctx context.Context,
fedResource FederatedResource,
clustersNoNeedHandleDeletion sets.Set[string],
) error {
keyedLogger := klog.FromContext(ctx)
syncedClusters, syncedClusterNames, err := s.getSyncedClusters(fedResource)
if err != nil {
return err
}
keyedLogger.V(4).Info("Check object removed from clusters", "clusters", strings.Join(syncedClusterNames, ","))
dispatcher := dispatch.NewCheckUnmanagedDispatcher(
s.getClusterClient,
fedResource.TargetGVR(),
fedResource.TargetName(),
)
unreadyClusters := []string{}
for _, cluster := range syncedClusters {
if !clusterutil.IsClusterReady(&cluster.Status) {
unreadyClusters = append(unreadyClusters, cluster.Name)
continue
}
if clustersNoNeedHandleDeletion.Has(cluster.Name) {
continue
}
dispatcher.CheckRemovedOrUnlabeled(ctx, cluster.Name)
}
ok, timeoutErr := dispatcher.Wait()
if timeoutErr != nil {
return timeoutErr
}
if len(unreadyClusters) > 0 {
return errors.Errorf("the following clusters were not ready: %s", strings.Join(unreadyClusters, ", "))
}
if !ok {
return errors.Errorf("one or more checks failed")
}
return nil
}
// handleDeletionInClusters invokes the provided deletion handler for
// each managed resource in member clusters.
func (s *SyncController) handleDeletionInClusters(
ctx context.Context,
fedResource FederatedResource,
deletionFunc func(dispatcher dispatch.UnmanagedDispatcher, clusterName string, clusterObj *unstructured.Unstructured),
) (sets.Set[string], bool, error) {
keyedLogger := klog.FromContext(ctx)
targetGVK := fedResource.TargetGVK()
targetGVR := fedResource.TargetGVR()
targetQualifiedName := fedResource.TargetName()
clustersNoNeedHandleDeletion := sets.Set[string]{}
syncedClusters, syncedClusterNames, err := s.getSyncedClusters(fedResource)
if err != nil {
return clustersNoNeedHandleDeletion, false, err
}
keyedLogger.V(4).Info("Handle deletion in clusters", "clusters", strings.Join(syncedClusterNames, ","))
dispatcher := dispatch.NewUnmanagedDispatcher(s.getClusterClient, targetGVR, targetQualifiedName, s.metrics)
retrievalFailureClusters := []string{}
unreadyClusters := []string{}
for _, cluster := range syncedClusters {
clusterName := cluster.Name
if !clusterutil.IsClusterReady(&cluster.Status) {
unreadyClusters = append(unreadyClusters, clusterName)
continue
}
clusterObj, _, err := informermanager.GetClusterObject(
ctx,
s.ftcManager,
s.fedInformerManager,
clusterName,
targetQualifiedName,
targetGVK,
)
if err != nil {
keyedLogger.WithValues("cluster-name", clusterName).
Error(err, "Failed to retrieve object in cluster")
retrievalFailureClusters = append(retrievalFailureClusters, clusterName)
continue
}
if clusterObj == nil {
clustersNoNeedHandleDeletion.Insert(clusterName)
continue
}
// If one of fedObject and clusterObj is a derived service and the other is not,
// the obtained clusterObj does not correspond to fedObj, and we do not need handle deletion.
if util.IsDerivedService(fedResource.Object().GetAnnotations()) != util.IsDerivedService(clusterObj.GetAnnotations()) {
clustersNoNeedHandleDeletion.Insert(clusterName)
continue
}
deletionFunc(dispatcher, clusterName, clusterObj)
}
ok, timeoutErr := dispatcher.Wait()
if timeoutErr != nil {
return clustersNoNeedHandleDeletion, false, timeoutErr
}
if len(retrievalFailureClusters) > 0 {
return clustersNoNeedHandleDeletion, false, errors.Errorf(
"failed to retrieve a managed resource for the following cluster(s): %s",
strings.Join(retrievalFailureClusters, ", "),
)
}
if len(unreadyClusters) > 0 {
return clustersNoNeedHandleDeletion, false,
errors.Errorf("the following clusters were not ready: %s", strings.Join(unreadyClusters, ", "))
}
return clustersNoNeedHandleDeletion, ok, nil
}
func (s *SyncController) getSyncedClusters(
fedResource FederatedResource,
) ([]*fedcorev1a1.FederatedCluster, []string, error) {
clusters, err := s.fedInformerManager.GetJoinedClusters()
if err != nil {
return nil, nil, fmt.Errorf("failed to get the list of joined clusters: %w", err)
}
clusterMap := make(map[string]*fedcorev1a1.FederatedCluster, len(clusters))
for _, cluster := range clusters {
clusterMap[cluster.Name] = cluster
}
status := fedResource.Object().GetStatus()
syncedClusters := make([]*fedcorev1a1.FederatedCluster, 0, len(status.Clusters))
syncedClusterNames := make([]string, 0, len(status.Clusters))
for _, cluster := range status.Clusters {
if cluster, exists := clusterMap[cluster.Cluster]; exists {
syncedClusters = append(syncedClusters, cluster)