-
Notifications
You must be signed in to change notification settings - Fork 346
/
labelidentity_controller.go
336 lines (306 loc) · 13.3 KB
/
labelidentity_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
/*
Copyright 2022 Antrea 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 member
import (
"context"
"sync"
"time"
v1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
ctrl "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/handler"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
"antrea.io/antrea/multicluster/apis/multicluster/constants"
mcsv1alpha1 "antrea.io/antrea/multicluster/apis/multicluster/v1alpha1"
"antrea.io/antrea/multicluster/controllers/multicluster/common"
"antrea.io/antrea/multicluster/controllers/multicluster/commonarea"
)
// LabelIdentityReconciler watches relevant Pod and Namespace events in the member cluster,
// computes the label identities added to and deleted from the cluster, and exports them to the
// leader cluster for further processing.
type (
LabelIdentityReconciler struct {
client.Client
Scheme *runtime.Scheme
commonAreaMutex sync.Mutex
commonAreaGetter commonarea.RemoteCommonAreaGetter
remoteCommonArea commonarea.RemoteCommonArea
// labelMutex prevents concurrent access to labelToPodsCache and podLabelCache.
// It also prevents concurrent updates to labelExportUpdatesInProgress.
labelMutex sync.RWMutex
// labelToPodsCache stores mapping from label identities to Pods that have this label identity.
labelToPodsCache map[string]sets.Set[string]
// podLabelCache stores mapping from Pods to their label identities.
podLabelCache map[string]string
// labelQueue maintains the normalized labels whose corresponding ResourceExport objects are
// determined to be created/deleted by the reconciler.
labelQueue workqueue.RateLimitingInterface
localClusterID string
}
)
func NewLabelIdentityReconciler(
client client.Client,
scheme *runtime.Scheme,
commonAreaGetter commonarea.RemoteCommonAreaGetter) *LabelIdentityReconciler {
return &LabelIdentityReconciler{
Client: client,
Scheme: scheme,
commonAreaGetter: commonAreaGetter,
labelToPodsCache: map[string]sets.Set[string]{},
podLabelCache: map[string]string{},
labelQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultItemBasedRateLimiter()),
}
}
// +kubebuilder:rbac:groups=multicluster.crd.antrea.io,resources=resourceexports,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch
// +kubebuilder:rbac:groups="",resources=namespaces,verbs=get;list;watch
func (r *LabelIdentityReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
klog.V(2).InfoS("Reconciling Pod for label identity", "pod", req.NamespacedName)
if requeue := r.checkRemoteCommonArea(); requeue {
return ctrl.Result{Requeue: true}, nil
}
var pod v1.Pod
var ns v1.Namespace
if err := r.Client.Get(ctx, req.NamespacedName, &pod); err != nil {
if apierrors.IsNotFound(err) {
klog.V(2).InfoS("Pod is deleted", "pod", req.NamespacedName)
r.onPodDelete(req.NamespacedName.String())
return ctrl.Result{}, nil
}
return ctrl.Result{}, err
}
if err := r.Client.Get(ctx, types.NamespacedName{Name: req.Namespace}, &ns); err != nil {
klog.ErrorS(err, "Cannot get corresponding Namespace of the Pod", "pod", req.NamespacedName)
return ctrl.Result{}, err
}
normalizedLabel := GetNormalizedLabel(ns.Labels, pod.Labels, ns.Name)
r.onPodCreateOrUpdate(req.NamespacedName.String(), normalizedLabel)
return ctrl.Result{}, nil
}
// checkRemoteCommonArea initializes remoteCommonArea for the reconciler if necessary,
// or tells the Reconcile function to requeue if the remoteCommonArea is not ready.
func (r *LabelIdentityReconciler) checkRemoteCommonArea() bool {
r.commonAreaMutex.Lock()
defer r.commonAreaMutex.Unlock()
if r.remoteCommonArea == nil {
commonArea, localClusterID, _ := r.commonAreaGetter.GetRemoteCommonAreaAndLocalID()
if commonArea == nil {
return true
}
r.remoteCommonArea, r.localClusterID = commonArea, localClusterID
}
return false
}
// SetupWithManager sets up the controller with the Manager.
func (r *LabelIdentityReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&v1.Pod{}).
WithEventFilter(predicate.LabelChangedPredicate{}).
Watches(&source.Kind{Type: &v1.Namespace{}},
handler.EnqueueRequestsFromMapFunc(r.namespaceMapFunc),
builder.WithPredicates(predicate.LabelChangedPredicate{})).
WithOptions(controller.Options{
MaxConcurrentReconciles: common.LabelIdentityWorkerCount,
}).
Complete(r)
}
// namespaceMapFunc handles Namespace update events (Namespace label change) by enqueuing
// all Pods in the Namespace into the reconciler processing queue.
func (r *LabelIdentityReconciler) namespaceMapFunc(ns client.Object) []reconcile.Request {
podList := &v1.PodList{}
r.Client.List(context.TODO(), podList, client.InNamespace(ns.GetName()))
requests := make([]reconcile.Request, len(podList.Items))
for i, pod := range podList.Items {
requests[i] = reconcile.Request{
NamespacedName: types.NamespacedName{
Name: pod.GetName(),
Namespace: pod.GetNamespace(),
},
}
}
return requests
}
// onPodDelete removes the Pod and label identity mapping from the cache, and queues the
// label identity for ResourceExport deletion if necessary (the Pod update/deletion event causes
// a label identity no longer present in the cluster).
func (r *LabelIdentityReconciler) onPodDelete(podNamespacedName string) {
r.labelMutex.Lock()
defer r.labelMutex.Unlock()
if originalLabel, isCached := r.podLabelCache[podNamespacedName]; isCached {
r.removeLabelForPod(podNamespacedName, originalLabel)
}
}
// removeLabelForPod removes the Pod and label identity mapping from the cache.
// It must be invoked with labelMutex held.
func (r *LabelIdentityReconciler) removeLabelForPod(podNamespacedName, originalLabel string) {
delete(r.podLabelCache, podNamespacedName)
// Check if the original label is stale.
if podNames, ok := r.labelToPodsCache[originalLabel]; ok && len(podNames) == 1 && podNames.Has(podNamespacedName) {
klog.V(2).InfoS("Label no longer exists in the cluster, queuing for ResourceExport deletion", "label", originalLabel)
delete(r.labelToPodsCache, originalLabel)
r.labelQueue.Add(originalLabel)
} else {
// The original label still has other Pod that refers to it. Simply update the cache.
podNames.Delete(podNamespacedName)
}
}
// onPodCreateOrUpdate updates the Pod and label identity mapping in the cache, and
// updates label identity ResourceExport if necessary (the Pod creation/update
// event causes a new label identity to appear in the cluster or a label identity
// no longer present in the cluster or both).
func (r *LabelIdentityReconciler) onPodCreateOrUpdate(podNamespacedName, currentLabel string) {
r.labelMutex.Lock()
defer r.labelMutex.Unlock()
if originalLabel, isCached := r.podLabelCache[podNamespacedName]; isCached && originalLabel != currentLabel {
r.removeLabelForPod(podNamespacedName, originalLabel)
}
r.podLabelCache[podNamespacedName] = currentLabel
podNames, ok := r.labelToPodsCache[currentLabel]
if !ok {
// Create a ResourceExport for this label as this is a new label.
klog.V(2).InfoS("New label in cluster, queuing for ResourceExport creation", "label", currentLabel)
r.labelToPodsCache[currentLabel] = sets.New[string](podNamespacedName)
r.labelQueue.Add(currentLabel)
} else {
// This is a seen label. Simply update the cache.
podNames.Insert(podNamespacedName)
}
}
// Run begins syncing of ResourceExports for label identities.
func (r *LabelIdentityReconciler) Run(stopCh <-chan struct{}) {
defer r.labelQueue.ShutDown()
for i := 0; i < common.LabelIdentityWorkerCount; i++ {
go wait.Until(r.labelQueueWorker, time.Second, stopCh)
}
<-stopCh
}
func (r *LabelIdentityReconciler) labelQueueWorker() {
for r.processLabelForResourceExport() {
}
}
// Processes an item in the labelQueue. If syncLabelResourceExport returns an error,
// this function handles it by re-queuing the item so that it can be processed again
// later. If syncLabelResourceExport is successful, the label is removed from the queue
// until we get notified of a new change. This function return false if and only if the
// work queue was shutdown (no more items will be processed).
func (r *LabelIdentityReconciler) processLabelForResourceExport() bool {
key, quit := r.labelQueue.Get()
if quit {
return false
}
defer r.labelQueue.Done(key)
err := r.syncLabelResourceExport(key.(string))
if err != nil {
// Put the item back on the workqueue to handle any transient errors.
r.labelQueue.AddRateLimited(key)
klog.ErrorS(err, "Failed to sync ResourceExport for label identity", "label", key)
return true
}
// If no error occurs, we forget this item so that it does not get queued again until
// another change happens.
r.labelQueue.Forget(key)
return true
}
// syncLabelResourceExport checks labelToPodsCache and determines whether a ResourceExport
// needs to be created or deleted for the label identity.
func (r *LabelIdentityReconciler) syncLabelResourceExport(label string) error {
r.labelMutex.RLock()
_, exists := r.labelToPodsCache[label]
r.labelMutex.RUnlock()
ctx := context.Background()
if exists {
// The queue received an event for this label, and there are Pods referring
// to this label. Either 1) a new label is encountered, and we need to create
// a ResourceExport for it, or 2) a Pod update/delete event triggered a label
// deletion, but is immediately followed by another Pod event triggering
// add for the same label, which is a quite improbable event. We can simply
// ignore AlreadyExists error in ResourceExport creation for the second case.
if err := r.createLabelIdentityResExport(ctx, label); err != nil {
return err
}
} else {
if err := r.deleteLabelIdentityResExport(ctx, label); err != nil {
return err
}
}
return nil
}
// createLabelIdentityResExport creates a ResourceExport for a newly added label.
func (r *LabelIdentityReconciler) createLabelIdentityResExport(ctx context.Context, labelToAdd string) error {
resExportName := getResourceExportNameForLabelIdentity(r.localClusterID, labelToAdd)
labelResExport := r.getLabelIdentityResourceExport(resExportName, labelToAdd)
klog.V(4).InfoS("Creating ResourceExport for label", "resourceExport", labelResExport.Name, "label", labelToAdd)
err := r.remoteCommonArea.Create(ctx, labelResExport, &client.CreateOptions{})
if err != nil && !apierrors.IsAlreadyExists(err) {
return err
}
return nil
}
// deleteLabelIdentityResExport deletes a ResourceExport for a stale label.
func (r *LabelIdentityReconciler) deleteLabelIdentityResExport(ctx context.Context, labelToDelete string) error {
labelResExport := &mcsv1alpha1.ResourceExport{
ObjectMeta: metav1.ObjectMeta{
Name: getResourceExportNameForLabelIdentity(r.localClusterID, labelToDelete),
Namespace: r.remoteCommonArea.GetNamespace(),
},
}
klog.V(4).InfoS("Deleting ResourceExport for label", "resourceExport", labelResExport.Name, "label", labelToDelete)
err := r.remoteCommonArea.Delete(ctx, labelResExport, &client.DeleteOptions{})
return client.IgnoreNotFound(err)
}
func (r *LabelIdentityReconciler) getLabelIdentityResourceExport(name, normalizedLabel string) *mcsv1alpha1.ResourceExport {
return &mcsv1alpha1.ResourceExport{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: r.remoteCommonArea.GetNamespace(),
Labels: map[string]string{
constants.SourceKind: constants.LabelIdentityKind,
constants.SourceClusterID: r.localClusterID,
},
},
Spec: mcsv1alpha1.ResourceExportSpec{
ClusterID: r.localClusterID,
Kind: constants.LabelIdentityKind,
LabelIdentity: &mcsv1alpha1.LabelIdentityExport{
NormalizedLabel: normalizedLabel,
},
},
}
}
func GetNormalizedLabel(nsLabels, podLabels map[string]string, ns string) string {
if _, ok := nsLabels[v1.LabelMetadataName]; !ok {
// NamespaceDefaultLabelName is supported from K8s v1.21. For K8s versions before v1.21,
// we append the Namespace name label to the Namespace label set, so that the exported
// label is guaranteed to have Namespace name information.
nsLabels[v1.LabelMetadataName] = ns
}
return "ns:" + labels.Set(nsLabels).String() + "&pod:" + labels.Set(podLabels).String()
}
// getResourceExportNameForLabelIdentity retrieves the ResourceExport name for exporting
// label identities in that cluster.
func getResourceExportNameForLabelIdentity(clusterID, normalizedLabel string) string {
return clusterID + "-" + common.HashLabelIdentity(normalizedLabel)
}