-
Notifications
You must be signed in to change notification settings - Fork 828
/
mcs_controller.go
465 lines (408 loc) · 17.2 KB
/
mcs_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
/*
Copyright 2023 The Karmada 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.
*/
package multiclusterservice
import (
"context"
"fmt"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
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"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
"k8s.io/klog/v2"
controllerruntime "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"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/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
clusterv1alpha1 "github.com/karmada-io/karmada/pkg/apis/cluster/v1alpha1"
networkingv1alpha1 "github.com/karmada-io/karmada/pkg/apis/networking/v1alpha1"
"github.com/karmada-io/karmada/pkg/events"
"github.com/karmada-io/karmada/pkg/sharedcli/ratelimiterflag"
"github.com/karmada-io/karmada/pkg/util"
"github.com/karmada-io/karmada/pkg/util/helper"
"github.com/karmada-io/karmada/pkg/util/names"
)
// ControllerName is the controller name that will be used when reporting events.
const ControllerName = "multiclusterservice-controller"
// MCSController is to sync MultiClusterService.
type MCSController struct {
client.Client
EventRecorder record.EventRecorder
RateLimiterOptions ratelimiterflag.Options
}
var (
serviceGVK = corev1.SchemeGroupVersion.WithKind("Service")
)
// Reconcile performs a full reconciliation for the object referred to by the Request.
// The Controller will requeue the Request to be processed again if an error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (c *MCSController) Reconcile(ctx context.Context, req controllerruntime.Request) (controllerruntime.Result, error) {
klog.V(4).InfoS("Reconciling MultiClusterService", "namespace", req.Namespace, "name", req.Name)
mcs := &networkingv1alpha1.MultiClusterService{}
if err := c.Client.Get(ctx, req.NamespacedName, mcs); err != nil {
if apierrors.IsNotFound(err) {
// The mcs no longer exist, in which case we stop processing.
return controllerruntime.Result{}, nil
}
klog.ErrorS(err, "failed to get MultiClusterService object", "NamespacedName", req.NamespacedName)
return controllerruntime.Result{}, err
}
if !mcs.DeletionTimestamp.IsZero() {
return c.handleMCSDelete(ctx, mcs.DeepCopy())
}
var err error
defer func() {
if err != nil {
_ = c.updateMCSStatus(mcs, metav1.ConditionFalse, "ServiceAppliedFailed", err.Error())
c.EventRecorder.Eventf(mcs, corev1.EventTypeWarning, events.EventReasonSyncServiceWorkFailed, err.Error())
return
}
_ = c.updateMCSStatus(mcs, metav1.ConditionTrue, "ServiceAppliedSucceed", "Service is propagated to target clusters.")
}()
if err = c.handleMCSCreateOrUpdate(ctx, mcs.DeepCopy()); err != nil {
return controllerruntime.Result{}, err
}
return controllerruntime.Result{}, nil
}
func (c *MCSController) handleMCSDelete(ctx context.Context, mcs *networkingv1alpha1.MultiClusterService) (controllerruntime.Result, error) {
klog.V(4).InfoS("Begin to handle MultiClusterService delete event", "namespace", mcs.Namespace, "name", mcs.Name)
if err := c.deleteServiceWork(mcs, sets.New[string]()); err != nil {
c.EventRecorder.Event(mcs, corev1.EventTypeWarning, events.EventReasonSyncServiceWorkFailed,
fmt.Sprintf("failed to delete service work :%v", err))
return controllerruntime.Result{}, err
}
if err := c.deleteMultiClusterServiceWork(mcs, true); err != nil {
c.EventRecorder.Event(mcs, corev1.EventTypeWarning, events.EventReasonSyncServiceWorkFailed,
fmt.Sprintf("failed to delete MultiClusterService work :%v", err))
return controllerruntime.Result{}, err
}
finalizersUpdated := controllerutil.RemoveFinalizer(mcs, util.MCSControllerFinalizer)
if finalizersUpdated {
err := c.Client.Update(ctx, mcs)
if err != nil {
klog.V(4).ErrorS(err, "failed to update MultiClusterService with finalizer",
"namespace", mcs.Namespace, "name", mcs.Name)
return controllerruntime.Result{}, err
}
}
klog.V(4).InfoS("Success to delete MultiClusterService", "namespace", mcs.Namespace, "name", mcs.Name)
return controllerruntime.Result{}, nil
}
func (c *MCSController) deleteServiceWork(mcs *networkingv1alpha1.MultiClusterService, retainClusters sets.Set[string]) error {
mcsID := util.GetLabelValue(mcs.Labels, networkingv1alpha1.MultiClusterServicePermanentIDLabel)
workList, err := helper.GetWorksByLabelsSet(c, labels.Set{
networkingv1alpha1.MultiClusterServicePermanentIDLabel: mcsID,
})
if err != nil {
klog.ErrorS(err, "failed to get work", "namespace", mcs.Namespace, "name", mcs.Name)
return err
}
for _, work := range workList.Items {
if !helper.IsWorkContains(work.Spec.Workload.Manifests, serviceGVK) {
continue
}
clusterName, err := names.GetClusterName(work.Namespace)
if err != nil {
klog.Errorf("Failed to get member cluster name for work %s/%s", work.Namespace, work.Name)
continue
}
if retainClusters.Has(clusterName) {
continue
}
if err = c.Client.Delete(context.TODO(), work.DeepCopy()); err != nil && !apierrors.IsNotFound(err) {
klog.Errorf("Error while deleting work(%s/%s) deletion timestamp: %s",
work.Namespace, work.Name, err)
return err
}
}
klog.V(4).InfoS("success to delete service work", "namespace", mcs.Namespace, "name", mcs.Name)
return nil
}
func (c *MCSController) deleteMultiClusterServiceWork(mcs *networkingv1alpha1.MultiClusterService, deleteAll bool) error {
mcsID := util.GetLabelValue(mcs.Labels, networkingv1alpha1.MultiClusterServicePermanentIDLabel)
workList, err := helper.GetWorksByLabelsSet(c, labels.Set{
networkingv1alpha1.MultiClusterServicePermanentIDLabel: mcsID,
})
if err != nil {
klog.Errorf("Failed to list work by MultiClusterService(%s/%s):%v", mcs.Namespace, mcs.Name, err)
return err
}
provisionClusters, err := helper.GetProvisionClusters(c.Client, mcs)
if err != nil {
klog.Errorf("Failed to get provision clusters by MultiClusterService(%s/%s):%v", mcs.Namespace, mcs.Name, err)
return err
}
for _, work := range workList.Items {
if !helper.IsWorkContains(work.Spec.Workload.Manifests, multiClusterServiceGVK) {
continue
}
clusterName, err := names.GetClusterName(work.Namespace)
if err != nil {
klog.Errorf("Failed to get member cluster name for work %s/%s:%v", work.Namespace, work.Name, work)
continue
}
if !deleteAll && provisionClusters.Has(clusterName) {
continue
}
if err = c.Client.Delete(context.TODO(), work.DeepCopy()); err != nil && !apierrors.IsNotFound(err) {
klog.Errorf("Error while updating work(%s/%s) deletion timestamp: %s",
work.Namespace, work.Name, err)
return err
}
}
klog.V(4).InfoS("Success to delete MultiClusterService work", "namespace", mcs.Namespace, "name", mcs.Name)
return nil
}
func (c *MCSController) handleMCSCreateOrUpdate(ctx context.Context, mcs *networkingv1alpha1.MultiClusterService) error {
klog.V(4).InfoS("Begin to handle MultiClusterService create or update event",
"namespace", mcs.Namespace, "name", mcs.Name)
// 1. if mcs not contain CrossCluster type, delete service work if needed
if !helper.MultiClusterServiceCrossClusterEnabled(mcs) {
if err := c.deleteServiceWork(mcs, sets.New[string]()); err != nil {
return err
}
if err := c.deleteMultiClusterServiceWork(mcs, true); err != nil {
return err
}
}
// 2. add finalizer if needed
finalizersUpdated := controllerutil.AddFinalizer(mcs, util.MCSControllerFinalizer)
if finalizersUpdated {
err := c.Client.Update(ctx, mcs)
if err != nil {
klog.V(4).ErrorS(err, "failed to update mcs with finalizer", "namespace", mcs.Namespace, "name", mcs.Name)
return err
}
}
// 3. Generate the MCS work
if err := c.ensureMultiClusterServiceWork(ctx, mcs); err != nil {
return err
}
// 4. make sure service exist
svc := &corev1.Service{}
err := c.Client.Get(ctx, types.NamespacedName{Namespace: mcs.Namespace, Name: mcs.Name}, svc)
if err != nil && !apierrors.IsNotFound(err) {
klog.ErrorS(err, "failed to get service", "namespace", mcs.Namespace, "name", mcs.Name)
return err
}
// 5. if service not exist, delete service work if needed
if apierrors.IsNotFound(err) {
delErr := c.deleteServiceWork(mcs, sets.New[string]())
if delErr != nil {
klog.ErrorS(err, "failed to delete service work", "namespace", mcs.Namespace, "name", mcs.Name)
c.EventRecorder.Event(mcs, corev1.EventTypeWarning, events.EventReasonSyncServiceWorkFailed,
fmt.Sprintf("failed to delete service work :%v", err))
}
return err
}
// 6. if service exist, create or update corresponding work in clusters
syncClusters, err := c.syncSVCWorkToClusters(ctx, mcs, svc)
if err != nil {
return err
}
// 7. delete MultiClusterService work not in provision clusters
if err = c.deleteMultiClusterServiceWork(mcs, false); err != nil {
return err
}
// 8. delete service work not in need sync clusters
if err = c.deleteServiceWork(mcs, syncClusters); err != nil {
return err
}
klog.V(4).InfoS("success to ensure service work", "namespace", mcs.Namespace, "name", mcs.Name)
return nil
}
func (c *MCSController) ensureMultiClusterServiceWork(ctx context.Context, mcs *networkingv1alpha1.MultiClusterService) error {
provisionCluster, err := helper.GetProvisionClusters(c.Client, mcs)
if err != nil {
klog.Errorf("Failed to get provision clusters by MultiClusterService(%s/%s):%v", mcs.Namespace, mcs.Name, err)
return err
}
for clusterName := range provisionCluster {
workMeta := metav1.ObjectMeta{
Name: names.GenerateMCSWorkName(mcs.Kind, mcs.Name, mcs.Namespace, clusterName),
Namespace: names.GenerateExecutionSpaceName(clusterName),
Labels: map[string]string{
// We add this id in mutating webhook, let's just use it
networkingv1alpha1.MultiClusterServicePermanentIDLabel: util.GetLabelValue(mcs.Labels, networkingv1alpha1.MultiClusterServicePermanentIDLabel),
util.ManagedByKarmadaLabel: util.ManagedByKarmadaLabelValue,
util.PropagationInstruction: util.PropagationInstructionSuppressed,
util.MultiClusterServiceNamespaceLabel: mcs.Namespace,
util.MultiClusterServiceNameLabel: mcs.Name,
},
}
mcsObj, err := helper.ToUnstructured(mcs)
if err != nil {
klog.Errorf("Failed to convert MultiClusterService(%s/%s) to unstructured object, err is %v", mcs.Namespace, mcs.Name, err)
return err
}
if err = helper.CreateOrUpdateWork(c, workMeta, mcsObj); err != nil {
klog.Errorf("Failed to create or update MultiClusterService(%s/%s) work in the given member cluster %s, err is %v",
mcs.Namespace, mcs.Name, clusterName, err)
return err
}
}
return nil
}
func (c *MCSController) syncSVCWorkToClusters(
ctx context.Context,
mcs *networkingv1alpha1.MultiClusterService,
svc *corev1.Service,
) (sets.Set[string], error) {
syncClusters := sets.New[string]()
clusters := &clusterv1alpha1.ClusterList{}
err := c.Client.List(ctx, clusters)
if err != nil {
klog.ErrorS(err, "failed to list clusters")
return syncClusters, err
}
serverLocations := sets.New[string](mcs.Spec.ServiceProvisionClusters...)
clientLocations := sets.New[string](mcs.Spec.ServiceConsumptionClusters...)
for _, cluster := range clusters.Items {
// if ServerLocations or ClientLocations are empty, we will sync work to the all clusters
if len(serverLocations) == 0 || len(clientLocations) == 0 ||
serverLocations.Has(cluster.Name) || clientLocations.Has(cluster.Name) {
syncClusters.Insert(cluster.Name)
}
}
svcObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(svc)
if err != nil {
return syncClusters, err
}
var errs []error
for clusterName := range syncClusters {
workMeta := metav1.ObjectMeta{
Name: names.GenerateMCSWorkName(svc.Kind, svc.Name, svc.Namespace, clusterName),
Namespace: names.GenerateExecutionSpaceName(clusterName),
Finalizers: []string{util.ExecutionControllerFinalizer},
Labels: map[string]string{
// We add this id in mutating webhook, let's just use it
networkingv1alpha1.MultiClusterServicePermanentIDLabel: util.GetLabelValue(mcs.Labels, networkingv1alpha1.MultiClusterServicePermanentIDLabel),
util.ManagedByKarmadaLabel: util.ManagedByKarmadaLabelValue,
},
}
if err = helper.CreateOrUpdateWork(c, workMeta, &unstructured.Unstructured{Object: svcObj}); err != nil {
klog.Errorf("Failed to create or update resource(%v/%v) in the given member cluster %s, err is %v",
workMeta.GetNamespace(), workMeta.GetName(), clusterName, err)
c.EventRecorder.Event(mcs, corev1.EventTypeWarning, events.EventReasonSyncServiceWorkFailed, fmt.Sprintf(
"Failed to create or update resource(%v/%v) in member cluster(%s): %v",
workMeta.GetNamespace(), workMeta.GetName(), clusterName, err))
errs = append(errs, err)
}
}
if len(errs) != 0 {
return syncClusters, errors.NewAggregate(errs)
}
return syncClusters, nil
}
func (c *MCSController) updateMCSStatus(mcs *networkingv1alpha1.MultiClusterService, status metav1.ConditionStatus, reason, message string) error {
serviceAppliedCondition := metav1.Condition{
Type: networkingv1alpha1.MCSServiceAppliedConditionType,
Status: status,
Reason: reason,
Message: message,
LastTransitionTime: metav1.Now(),
}
return retry.RetryOnConflict(retry.DefaultRetry, func() (err error) {
meta.SetStatusCondition(&mcs.Status.Conditions, serviceAppliedCondition)
updateErr := c.Status().Update(context.TODO(), mcs)
if updateErr == nil {
return nil
}
updated := &networkingv1alpha1.MultiClusterService{}
if err = c.Get(context.TODO(), client.ObjectKey{Namespace: mcs.Namespace, Name: mcs.Name}, updated); err == nil {
mcs = updated
} else {
klog.Errorf("Failed to get updated MultiClusterService %s/%s: %v", mcs.Namespace, mcs.Name, err)
}
return updateErr
})
}
// SetupWithManager creates a controller and register to controller manager.
func (c *MCSController) SetupWithManager(mgr controllerruntime.Manager) error {
mcsPredicateFunc := predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool {
mcs := e.Object.(*networkingv1alpha1.MultiClusterService)
return helper.MultiClusterServiceCrossClusterEnabled(mcs)
},
UpdateFunc: func(e event.UpdateEvent) bool {
mcsOld := e.ObjectOld.(*networkingv1alpha1.MultiClusterService)
mcsNew := e.ObjectNew.(*networkingv1alpha1.MultiClusterService)
if !helper.MultiClusterServiceCrossClusterEnabled(mcsOld) && !helper.MultiClusterServiceCrossClusterEnabled(mcsNew) {
return false
}
// We only care about the update events below:
if equality.Semantic.DeepEqual(mcsOld.Annotations, mcsNew.Annotations) &&
equality.Semantic.DeepEqual(mcsOld.Spec, mcsNew.Spec) &&
equality.Semantic.DeepEqual(mcsOld.DeletionTimestamp.IsZero(), mcsNew.DeletionTimestamp.IsZero()) {
return false
}
return true
},
DeleteFunc: func(event.DeleteEvent) bool {
// Since finalizer is added to the MultiClusterService object,
// the delete event is processed by the update event.
return false
},
GenericFunc: func(event.GenericEvent) bool {
return true
},
}
svcPredicateFunc := predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool {
return true
},
UpdateFunc: func(e event.UpdateEvent) bool {
svcOld := e.ObjectOld.(*corev1.Service)
svcNew := e.ObjectNew.(*corev1.Service)
// We only care about the update events below:
if equality.Semantic.DeepEqual(svcOld.Annotations, svcNew.Annotations) &&
equality.Semantic.DeepEqual(svcOld.Spec, svcNew.Spec) {
return false
}
return true
},
DeleteFunc: func(event.DeleteEvent) bool {
return true
},
GenericFunc: func(event.GenericEvent) bool {
return true
},
}
svcMapFunc := handler.MapFunc(
func(ctx context.Context, svcObj client.Object) []reconcile.Request {
return []reconcile.Request{{
NamespacedName: types.NamespacedName{
Namespace: svcObj.GetNamespace(),
Name: svcObj.GetName(),
},
}}
})
return controllerruntime.NewControllerManagedBy(mgr).
For(&networkingv1alpha1.MultiClusterService{}, builder.WithPredicates(mcsPredicateFunc)).
Watches(&corev1.Service{}, handler.EnqueueRequestsFromMapFunc(svcMapFunc), builder.WithPredicates(svcPredicateFunc)).
WithOptions(controller.Options{RateLimiter: ratelimiterflag.DefaultControllerRateLimiter(c.RateLimiterOptions)}).
Complete(c)
}