/
controller.go
456 lines (409 loc) · 14.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
// Copyright 2021 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 serviceexternalip
import (
"fmt"
"sync"
"time"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
apimachinerytypes "k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
coreinformers "k8s.io/client-go/informers/core/v1"
"k8s.io/client-go/kubernetes"
corelisters "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
"antrea.io/antrea/pkg/agent/ipassigner"
"antrea.io/antrea/pkg/agent/memberlist"
"antrea.io/antrea/pkg/agent/types"
"antrea.io/antrea/pkg/querier"
)
const (
controllerName = "ServiceExternalIPController"
// How long to wait before retrying the processing of an Service change.
minRetryDelay = 5 * time.Second
maxRetryDelay = 300 * time.Second
// Default number of workers processing an Service change.
defaultWorkers = 1
// Disable resyncing.
resyncPeriod time.Duration = 0
externalIPIndex = "externalIP"
externalIPPoolIndex = "externalIPPool"
)
type externalIPState struct {
ip string
ipPool string
assignedNode string
}
type ServiceExternalIPController struct {
nodeName string
serviceInformer cache.SharedIndexInformer
serviceLister corelisters.ServiceLister
serviceListerSynced cache.InformerSynced
client kubernetes.Interface
endpointsInformer cache.SharedIndexInformer
endpointsLister corelisters.EndpointsLister
endpointsListerSynced cache.InformerSynced
queue workqueue.RateLimitingInterface
externalIPStates map[apimachinerytypes.NamespacedName]externalIPState
externalIPStatesMutex sync.RWMutex
cluster memberlist.Interface
ipAssigner ipassigner.IPAssigner
assignedIPs map[string]sets.String
assignedIPsMutex sync.Mutex
}
var _ querier.ServiceExternalIPStatusQuerier = (*ServiceExternalIPController)(nil)
func NewServiceExternalIPController(
nodeName string,
nodeTransportInterface string,
client kubernetes.Interface,
cluster memberlist.Interface,
serviceInformer coreinformers.ServiceInformer,
endpointsInformer coreinformers.EndpointsInformer,
) (*ServiceExternalIPController, error) {
c := &ServiceExternalIPController{
nodeName: nodeName,
client: client,
cluster: cluster,
queue: workqueue.NewNamedRateLimitingQueue(workqueue.NewItemExponentialFailureRateLimiter(minRetryDelay, maxRetryDelay), "AgentServiceExternalIP"),
serviceInformer: serviceInformer.Informer(),
serviceLister: serviceInformer.Lister(),
serviceListerSynced: serviceInformer.Informer().HasSynced,
endpointsInformer: endpointsInformer.Informer(),
endpointsLister: endpointsInformer.Lister(),
endpointsListerSynced: endpointsInformer.Informer().HasSynced,
externalIPStates: make(map[apimachinerytypes.NamespacedName]externalIPState),
assignedIPs: make(map[string]sets.String),
}
ipAssigner, err := ipassigner.NewIPAssigner(nodeTransportInterface, "")
if err != nil {
return nil, fmt.Errorf("initializing service external IP assigner failed: %v", err)
}
c.ipAssigner = ipAssigner
c.serviceInformer.AddIndexers(cache.Indexers{
externalIPIndex: func(obj interface{}) ([]string, error) {
service, ok := obj.(*corev1.Service)
if !ok {
return nil, fmt.Errorf("obj is not Service: %+v", obj)
}
if len(service.Status.LoadBalancer.Ingress) == 0 {
return nil, nil
}
return []string{service.Status.LoadBalancer.Ingress[0].IP}, nil
},
externalIPPoolIndex: func(obj interface{}) ([]string, error) {
service, ok := obj.(*corev1.Service)
if !ok {
return nil, fmt.Errorf("obj is not Service: %+v", obj)
}
eipName, ok := service.Annotations[types.ServiceExternalIPPoolAnnotationKey]
if !ok {
return nil, nil
}
return []string{eipName}, nil
}},
)
c.serviceInformer.AddEventHandlerWithResyncPeriod(
cache.ResourceEventHandlerFuncs{
AddFunc: c.enqueueService,
UpdateFunc: func(old, cur interface{}) {
c.enqueueService(cur)
},
DeleteFunc: c.enqueueService,
},
resyncPeriod,
)
c.endpointsInformer.AddEventHandlerWithResyncPeriod(
cache.ResourceEventHandlerFuncs{
AddFunc: c.enqueueServiceForEndpoints,
UpdateFunc: func(old, cur interface{}) {
c.enqueueServiceForEndpoints(cur)
},
DeleteFunc: c.enqueueServiceForEndpoints,
},
resyncPeriod,
)
c.cluster.AddClusterEventHandler(c.enqueueServicesByExternalIPPool)
return c, nil
}
func (c *ServiceExternalIPController) enqueueService(obj interface{}) {
service, ok := obj.(*corev1.Service)
if !ok {
deletedState, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
klog.Errorf("Received unexpected object: %v", obj)
return
}
service, ok = deletedState.Obj.(*corev1.Service)
if !ok {
klog.Errorf("DeletedFinalStateUnknown contains non-Service object: %v", deletedState.Obj)
return
}
}
key := apimachinerytypes.NamespacedName{
Namespace: service.Namespace,
Name: service.Name,
}
c.queue.Add(key)
}
func (c *ServiceExternalIPController) enqueueServiceForEndpoints(obj interface{}) {
endpoints, ok := obj.(*corev1.Endpoints)
if !ok {
deletedState, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
klog.Errorf("Received unexpected object: %v", obj)
return
}
endpoints, ok = deletedState.Obj.(*corev1.Endpoints)
if !ok {
klog.Errorf("DeletedFinalStateUnknown contains non-Endpoint object: %v", deletedState.Obj)
return
}
}
service, err := c.serviceLister.Services(endpoints.Namespace).Get(endpoints.Name)
if err != nil {
// The only possible error Lister.Get can return is NotFound.
// It's normal that some Endpoints don't have Service. For example, kube-scheduler and kube-controller-manager
// may use Endpoints for leader election. Even if the Endpoints should have a Service but it's not received yet,
// it's fine to ignore the error as the Service's add event will enqueue it.
klog.V(5).InfoS("Failed to get Service for Endpoints", "Endpoints", klog.KObj(endpoints), "err", err)
return
}
// we only care services with ServiceExternalTrafficPolicy setting to local.
if service.Spec.ExternalTrafficPolicy != corev1.ServiceExternalTrafficPolicyTypeLocal || service.Spec.Type != corev1.ServiceTypeLoadBalancer {
return
}
c.queue.Add(apimachinerytypes.NamespacedName{
Namespace: service.Namespace,
Name: service.Name,
})
}
// enqueueServicesByExternalIPPool enqueues all services that refer to the provided ExternalIPPool,
// the ExternalIPPool is affected by a Node update/create/delete event or Node leaves/join cluster
// event or ExternalIPPool changed event.
func (c *ServiceExternalIPController) enqueueServicesByExternalIPPool(eipName string) {
objects, _ := c.serviceInformer.GetIndexer().ByIndex(externalIPPoolIndex, eipName)
for _, object := range objects {
service := object.(*corev1.Service)
c.queue.Add(apimachinerytypes.NamespacedName{
Namespace: service.Namespace,
Name: service.Name,
})
}
klog.InfoS("Detected ExternalIPPool event", "ExternalIPPool", eipName, "enqueueServiceNum", len(objects))
}
// Run will create defaultWorkers workers (go routines) which will process the Service events from the
// workqueue.
func (c *ServiceExternalIPController) Run(stopCh <-chan struct{}) {
defer c.queue.ShutDown()
go c.ipAssigner.Run(stopCh)
klog.Infof("Starting %s", controllerName)
defer klog.Infof("Shutting down %s", controllerName)
if !cache.WaitForNamedCacheSync(controllerName, stopCh, c.serviceListerSynced, c.endpointsListerSynced) {
return
}
for i := 0; i < defaultWorkers; i++ {
go wait.Until(c.worker, time.Second, stopCh)
}
<-stopCh
}
// worker is a long-running function that will continually call the processNextWorkItem function in
// order to read and process a message on the workqueue.
func (c *ServiceExternalIPController) worker() {
for c.processNextWorkItem() {
}
}
func (c *ServiceExternalIPController) processNextWorkItem() bool {
obj, quit := c.queue.Get()
if quit {
return false
}
defer c.queue.Done(obj)
if key, ok := obj.(apimachinerytypes.NamespacedName); !ok {
c.queue.Forget(obj)
klog.Errorf("Expected NamespacedName in work queue but got %#v", obj)
return true
} else if err := c.syncService(key); err == nil {
// If no error occurs we Forget this item so it does not get queued again until
// another change happens.
c.queue.Forget(key)
} else {
// Put the item back on the workqueue to handle any transient errors.
c.queue.AddRateLimited(key)
klog.ErrorS(err, "Error syncing Service", "Service", key)
}
return true
}
func (c *ServiceExternalIPController) deleteService(service apimachinerytypes.NamespacedName) error {
c.externalIPStatesMutex.Lock()
defer c.externalIPStatesMutex.Unlock()
var state externalIPState
var exist bool
if state, exist = c.externalIPStates[service]; !exist {
return nil
}
if err := c.unassignIP(state.ip, service); err != nil {
return err
}
delete(c.externalIPStates, service)
return nil
}
func (c *ServiceExternalIPController) getServiceState(service *corev1.Service) (externalIPState, bool) {
c.externalIPStatesMutex.RLock()
defer c.externalIPStatesMutex.RUnlock()
name := apimachinerytypes.NamespacedName{
Namespace: service.Namespace,
Name: service.Name,
}
state, exist := c.externalIPStates[name]
return state, exist
}
func (c *ServiceExternalIPController) saveServiceState(service *corev1.Service, state *externalIPState) {
c.externalIPStatesMutex.Lock()
defer c.externalIPStatesMutex.Unlock()
name := apimachinerytypes.NamespacedName{
Namespace: service.Namespace,
Name: service.Name,
}
c.externalIPStates[name] = *state
}
func (c *ServiceExternalIPController) getServiceExternalIP(service *corev1.Service) string {
if len(service.Status.LoadBalancer.Ingress) == 0 {
return ""
}
return service.Status.LoadBalancer.Ingress[0].IP
}
func (c *ServiceExternalIPController) syncService(key apimachinerytypes.NamespacedName) error {
startTime := time.Now()
defer func() {
klog.V(4).Infof("Finished syncing Service for %s. (%v)", key, time.Since(startTime))
}()
service, err := c.serviceLister.Services(key.Namespace).Get(key.Name)
if err != nil {
if errors.IsNotFound(err) {
return c.deleteService(key)
}
return err
}
if service.Spec.Type != corev1.ServiceTypeLoadBalancer {
return c.deleteService(key)
}
prevState, exist := c.getServiceState(service)
currentExternalIP := c.getServiceExternalIP(service)
if exist && prevState.ip != currentExternalIP {
// External IP of the Service has changed. Delete the previous assigned IP if exists.
if err := c.deleteService(key); err != nil {
return err
}
}
ipPool := service.ObjectMeta.Annotations[types.ServiceExternalIPPoolAnnotationKey]
state := &externalIPState{
ip: currentExternalIP,
ipPool: ipPool,
}
defer c.saveServiceState(service, state)
if currentExternalIP == "" || ipPool == "" {
return nil
}
var filters []func(string) bool
if service.Spec.ExternalTrafficPolicy == corev1.ServiceExternalTrafficPolicyTypeLocal {
nodes, err := c.nodesHasHealthyServiceEndpoint(service)
if err != nil {
return err
}
filters = append(filters, func(s string) bool {
return nodes.Has(s)
})
}
nodeName, err := c.cluster.SelectNodeForIP(currentExternalIP, ipPool, filters...)
if err != nil {
if err == memberlist.ErrNoNodeAvailable {
// No Node is available at the moment. The Service will be requeued by Endpoints, Node, or Memberlist update events.
klog.InfoS("No Node available", "ip", currentExternalIP, "ipPool", ipPool)
return nil
}
return err
}
klog.InfoS("Select Node for IP", "service", key, "nodeName", nodeName, "currentExternalIP", currentExternalIP, "ipPool", ipPool)
state.assignedNode = nodeName
if state.assignedNode == c.nodeName {
return c.assignIP(currentExternalIP, key)
}
return c.unassignIP(currentExternalIP, key)
}
func (c *ServiceExternalIPController) assignIP(ip string, service apimachinerytypes.NamespacedName) error {
c.assignedIPsMutex.Lock()
defer c.assignedIPsMutex.Unlock()
if _, ok := c.assignedIPs[ip]; !ok {
if err := c.ipAssigner.AssignIP(ip); err != nil {
return err
}
c.assignedIPs[ip] = sets.NewString(service.String())
} else {
c.assignedIPs[ip].Insert(service.String())
}
return nil
}
func (c *ServiceExternalIPController) unassignIP(ip string, service apimachinerytypes.NamespacedName) error {
c.assignedIPsMutex.Lock()
defer c.assignedIPsMutex.Unlock()
assigned, ok := c.assignedIPs[ip]
if !ok {
return nil
}
if assigned.Len() == 1 && assigned.Has(service.String()) {
if err := c.ipAssigner.UnassignIP(ip); err != nil {
return err
}
delete(c.assignedIPs, ip)
return nil
}
assigned.Delete(service.String())
return nil
}
// nodesHasHealthyServiceEndpoint returns the set of Nodes which has at least one healthy endpoint.
func (c *ServiceExternalIPController) nodesHasHealthyServiceEndpoint(service *corev1.Service) (sets.String, error) {
nodes := sets.NewString()
endpoints, err := c.endpointsLister.Endpoints(service.Namespace).Get(service.Name)
if err != nil {
return nodes, err
}
for _, subset := range endpoints.Subsets {
for _, ep := range subset.Addresses {
if ep.NodeName == nil {
continue
}
nodes.Insert(*ep.NodeName)
}
}
return nodes, nil
}
func (c *ServiceExternalIPController) GetServiceExternalIPStatus() []querier.ServiceExternalIPInfo {
c.externalIPStatesMutex.RLock()
defer c.externalIPStatesMutex.RUnlock()
info := make([]querier.ServiceExternalIPInfo, 0, len(c.externalIPStates))
for k, v := range c.externalIPStates {
info = append(info, querier.ServiceExternalIPInfo{
ServiceName: k.Name,
Namespace: k.Namespace,
ExternalIP: v.ip,
ExternalIPPool: v.ipPool,
AssignedNode: v.assignedNode,
})
}
return info
}