forked from kubernetes/ingress-gce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
controller.go
490 lines (434 loc) · 14.3 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
/*
Copyright 2017 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.
*/
package neg
import (
"encoding/json"
"fmt"
"strconv"
"time"
"github.com/golang/glog"
apiv1 "k8s.io/api/core/v1"
extensions "k8s.io/api/extensions/v1beta1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme"
unversionedcore "k8s.io/client-go/kubernetes/typed/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
"k8s.io/ingress-gce/pkg/annotations"
"k8s.io/ingress-gce/pkg/context"
"k8s.io/ingress-gce/pkg/neg/metrics"
negtypes "k8s.io/ingress-gce/pkg/neg/types"
"k8s.io/ingress-gce/pkg/utils"
)
func init() {
// register prometheus metrics
metrics.RegisterMetrics()
}
// Controller is network endpoint group controller.
// It determines whether NEG for a service port is needed, then signals NegSyncerManager to sync it.
type Controller struct {
manager negtypes.NegSyncerManager
resyncPeriod time.Duration
gcPeriod time.Duration
recorder record.EventRecorder
namer negtypes.NetworkEndpointGroupNamer
zoneGetter negtypes.ZoneGetter
ingressSynced cache.InformerSynced
serviceSynced cache.InformerSynced
endpointSynced cache.InformerSynced
ingressLister cache.Indexer
serviceLister cache.Indexer
client kubernetes.Interface
// serviceQueue takes service key as work item. Service key with format "namespace/name".
serviceQueue workqueue.RateLimitingInterface
// endpointQueue takes endpoint key as work item. Endpoint key with format "namespace/name".
endpointQueue workqueue.RateLimitingInterface
// syncTracker tracks the latest time that service and endpoint changes are processed
syncTracker utils.TimeTracker
}
// NewController returns a network endpoint group controller.
func NewController(
cloud negtypes.NetworkEndpointGroupCloud,
ctx *context.ControllerContext,
zoneGetter negtypes.ZoneGetter,
namer negtypes.NetworkEndpointGroupNamer,
resyncPeriod time.Duration,
gcPeriod time.Duration) *Controller {
// init event recorder
// TODO: move event recorder initializer to main. Reuse it among controllers.
eventBroadcaster := record.NewBroadcaster()
eventBroadcaster.StartLogging(glog.Infof)
eventBroadcaster.StartRecordingToSink(&unversionedcore.EventSinkImpl{
Interface: ctx.KubeClient.Core().Events(""),
})
recorder := eventBroadcaster.NewRecorder(scheme.Scheme,
apiv1.EventSource{Component: "neg-controller"})
manager := newSyncerManager(namer, recorder, cloud, zoneGetter, ctx.ServiceInformer.GetIndexer(), ctx.EndpointInformer.GetIndexer())
negController := &Controller{
client: ctx.KubeClient,
manager: manager,
resyncPeriod: resyncPeriod,
gcPeriod: gcPeriod,
recorder: recorder,
zoneGetter: zoneGetter,
namer: namer,
ingressSynced: ctx.IngressInformer.HasSynced,
serviceSynced: ctx.ServiceInformer.HasSynced,
endpointSynced: ctx.EndpointInformer.HasSynced,
ingressLister: ctx.IngressInformer.GetIndexer(),
serviceLister: ctx.ServiceInformer.GetIndexer(),
serviceQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
endpointQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
syncTracker: utils.NewTimeTracker(),
}
ctx.IngressInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
addIng := obj.(*extensions.Ingress)
if !utils.IsGLBCIngress(addIng) {
glog.V(4).Infof("Ignoring add for ingress %v based on annotation %v", utils.IngressKeyFunc(addIng), annotations.IngressClassKey)
return
}
negController.enqueueIngressServices(addIng)
},
DeleteFunc: func(obj interface{}) {
delIng := obj.(*extensions.Ingress)
if !utils.IsGLBCIngress(delIng) {
glog.V(4).Infof("Ignoring delete for ingress %v based on annotation %v", utils.IngressKeyFunc(delIng), annotations.IngressClassKey)
return
}
negController.enqueueIngressServices(delIng)
},
UpdateFunc: func(old, cur interface{}) {
oldIng := cur.(*extensions.Ingress)
curIng := cur.(*extensions.Ingress)
if !utils.IsGLBCIngress(curIng) {
glog.V(4).Infof("Ignoring update for ingress %v based on annotation %v", utils.IngressKeyFunc(curIng), annotations.IngressClassKey)
return
}
keys := gatherIngressServiceKeys(oldIng)
keys = keys.Union(gatherIngressServiceKeys(curIng))
for _, key := range keys.List() {
negController.enqueueService(cache.ExplicitKey(key))
}
},
})
ctx.ServiceInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: negController.enqueueService,
DeleteFunc: negController.enqueueService,
UpdateFunc: func(old, cur interface{}) {
negController.enqueueService(cur)
},
})
ctx.EndpointInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: negController.enqueueEndpoint,
DeleteFunc: negController.enqueueEndpoint,
UpdateFunc: func(old, cur interface{}) {
negController.enqueueEndpoint(cur)
},
})
ctx.AddHealthCheck("neg-controller", negController.IsHealthy)
return negController
}
func (c *Controller) Run(stopCh <-chan struct{}) {
wait.PollUntil(5*time.Second, func() (bool, error) {
glog.V(2).Infof("Waiting for initial sync")
return c.synced(), nil
}, stopCh)
glog.V(2).Infof("Starting network endpoint group controller")
defer func() {
glog.V(2).Infof("Shutting down network endpoint group controller")
c.stop()
}()
go wait.Until(c.serviceWorker, time.Second, stopCh)
go wait.Until(c.endpointWorker, time.Second, stopCh)
go func() {
// Wait for gcPeriod to run the first GC
// This is to make sure that all services are fully processed before running GC.
time.Sleep(c.gcPeriod)
wait.Until(c.gc, c.gcPeriod, stopCh)
}()
<-stopCh
}
func (c *Controller) IsHealthy() error {
// check if last seen service and endpoint processing is more than an hour ago
if c.syncTracker.Get().Before(time.Now().Add(-time.Hour)) {
msg := fmt.Sprintf("NEG controller has not processed any service "+
"and endpoint updates for more than an hour. Something went wrong. "+
"Last sync was on %v", c.syncTracker.Get())
glog.Error(msg)
return fmt.Errorf(msg)
}
return nil
}
func (c *Controller) stop() {
glog.V(2).Infof("Shutting down network endpoint group controller")
c.serviceQueue.ShutDown()
c.endpointQueue.ShutDown()
c.manager.ShutDown()
}
func (c *Controller) endpointWorker() {
for {
func() {
key, quit := c.endpointQueue.Get()
if quit {
return
}
c.processEndpoint(key.(string))
c.endpointQueue.Done(key)
}()
}
}
// processEndpoint finds the related syncers and signal it to sync
func (c *Controller) processEndpoint(key string) {
defer func() {
now := c.syncTracker.Track()
metrics.LastSyncTimestamp.WithLabelValues().Set(float64(now.UTC().UnixNano()))
}()
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
glog.Errorf("Failed to split endpoint namespaced key %q: %v", key, err)
return
}
c.manager.Sync(namespace, name)
}
func (c *Controller) serviceWorker() {
for {
func() {
key, quit := c.serviceQueue.Get()
if quit {
return
}
defer c.serviceQueue.Done(key)
err := c.processService(key.(string))
c.handleErr(err, key)
}()
}
}
// processService takes a service and determines whether it needs NEGs or not.
func (c *Controller) processService(key string) error {
defer func() {
now := c.syncTracker.Track()
metrics.LastSyncTimestamp.WithLabelValues().Set(float64(now.UTC().UnixNano()))
}()
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
return err
}
svc, exists, err := c.serviceLister.GetByKey(key)
if err != nil {
return err
}
if !exists {
c.manager.StopSyncer(namespace, name)
return nil
}
var service *apiv1.Service
var foundNEGAnnotation bool
var negAnnotation *annotations.NegAnnotation
if exists {
service = svc.(*apiv1.Service)
foundNEGAnnotation, negAnnotation, err = annotations.FromService(service).NEGAnnotation()
if err != nil {
return err
}
}
if !foundNEGAnnotation || !negAnnotation.NEGEnabled() {
c.manager.StopSyncer(namespace, name)
// delete the annotation
return c.syncNegStatusAnnotation(namespace, name, make(negtypes.PortNameMap))
}
glog.V(2).Infof("Syncing service %q", key)
// map of ServicePort (int) to TargetPort
svcPortMap := make(negtypes.PortNameMap)
if negAnnotation.NEGEnabledForIngress() {
// Only service ports referenced by ingress are synced for NEG
ings := getIngressServicesFromStore(c.ingressLister, service)
svcPortMap = gatherPortMappingUsedByIngress(ings, service)
}
if negAnnotation.NEGExposed() {
knownPorts := make(negtypes.PortNameMap)
for _, sp := range service.Spec.Ports {
knownPorts[sp.Port] = sp.TargetPort.String()
}
negSvcPorts, err := NEGServicePorts(negAnnotation, knownPorts)
if err != nil {
return err
}
svcPortMap = svcPortMap.Union(negSvcPorts)
}
err = c.syncNegStatusAnnotation(namespace, name, svcPortMap)
if err != nil {
return err
}
return c.manager.EnsureSyncers(namespace, name, svcPortMap)
}
func (c *Controller) syncNegStatusAnnotation(namespace, name string, portMap negtypes.PortNameMap) error {
zones, err := c.zoneGetter.ListZones()
if err != nil {
return err
}
svcClient := c.client.CoreV1().Services(namespace)
service, err := svcClient.Get(name, metav1.GetOptions{})
if err != nil {
return err
}
// Remove NEG Status Annotation when no NEG is needed
if len(portMap) == 0 {
if _, ok := service.Annotations[annotations.NEGStatusKey]; ok {
// TODO: use PATCH to remove annotation
delete(service.Annotations, annotations.NEGStatusKey)
glog.V(2).Infof("Removing expose NEG annotation from service: %s/%s", namespace, name)
_, err = svcClient.Update(service)
return err
}
// service doesn't have the expose NEG annotation and doesn't need update
return nil
}
portToNegs := make(negtypes.PortNameMap)
for svcPort := range portMap {
portToNegs[svcPort] = c.namer.NEG(namespace, name, svcPort)
}
negSvcState := GetNegStatus(zones, portToNegs)
bytes, err := json.Marshal(negSvcState)
if err != nil {
return err
}
annotation := string(bytes)
existingAnnotation, ok := service.Annotations[annotations.NEGStatusKey]
if ok && existingAnnotation == annotation {
return nil
}
service.Annotations[annotations.NEGStatusKey] = annotation
glog.V(2).Infof("Updating NEG visibility annotation %q on service %s/%s.", annotation, namespace, name)
_, err = svcClient.Update(service)
return err
}
func (c *Controller) handleErr(err error, key interface{}) {
if err == nil {
c.serviceQueue.Forget(key)
return
}
msg := fmt.Sprintf("error processing service %q: %v", key, err)
glog.Errorf(msg)
if service, exists, err := c.serviceLister.GetByKey(key.(string)); err != nil {
glog.Warning("Failed to retrieve service %q from store: %v", key.(string), err)
} else if exists {
c.recorder.Eventf(service.(*apiv1.Service), apiv1.EventTypeWarning, "ProcessServiceFailed", msg)
}
c.serviceQueue.AddRateLimited(key)
}
func (c *Controller) enqueueEndpoint(obj interface{}) {
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err != nil {
glog.Errorf("Failed to generate endpoint key: %v", err)
return
}
c.endpointQueue.Add(key)
}
func (c *Controller) enqueueService(obj interface{}) {
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err != nil {
glog.Errorf("Failed to generate service key: %v", err)
return
}
c.serviceQueue.Add(key)
}
func (c *Controller) enqueueIngressServices(ing *extensions.Ingress) {
keys := gatherIngressServiceKeys(ing)
for key := range keys {
c.enqueueService(cache.ExplicitKey(key))
}
}
func (c *Controller) gc() {
if err := c.manager.GC(); err != nil {
glog.Errorf("NEG controller garbage collection failed: %v", err)
}
}
func (c *Controller) synced() bool {
return c.endpointSynced() &&
c.serviceSynced() &&
c.ingressSynced()
}
// gatherPortMappingUsedByIngress returns a map containing port:targetport
// of all service ports of the service that are referenced by ingresses
func gatherPortMappingUsedByIngress(ings []extensions.Ingress, svc *apiv1.Service) negtypes.PortNameMap {
servicePorts := sets.NewString()
ingressSvcPorts := make(negtypes.PortNameMap)
for _, ing := range ings {
if utils.IsGLBCIngress(&ing) {
utils.TraverseIngressBackends(&ing, func(id utils.ServicePortID) bool {
if id.Service.Name == svc.Name {
servicePorts.Insert(id.Port.String())
}
return false
})
}
}
for _, svcPort := range svc.Spec.Ports {
found := false
for _, refSvcPort := range servicePorts.List() {
port, err := strconv.Atoi(refSvcPort)
if err != nil {
// port name matches
if refSvcPort == svcPort.Name {
found = true
break
}
} else {
// service port matches
if port == int(svcPort.Port) {
found = true
break
}
}
}
if found {
ingressSvcPorts[svcPort.Port] = svcPort.TargetPort.String()
}
}
return ingressSvcPorts
}
// gatherIngressServiceKeys returns all service key (formatted as namespace/name) referenced in the ingress
func gatherIngressServiceKeys(ing *extensions.Ingress) sets.String {
set := sets.NewString()
if ing == nil {
return set
}
utils.TraverseIngressBackends(ing, func(id utils.ServicePortID) bool {
set.Insert(utils.ServiceKeyFunc(id.Service.Namespace, id.Service.Name))
return false
})
return set
}
func getIngressServicesFromStore(store cache.Store, svc *apiv1.Service) (ings []extensions.Ingress) {
for _, m := range store.List() {
ing := *m.(*extensions.Ingress)
if ing.Namespace != svc.Namespace {
continue
}
if utils.IsGLBCIngress(&ing) {
utils.TraverseIngressBackends(&ing, func(id utils.ServicePortID) bool {
if id.Service.Name == svc.Name {
ings = append(ings, ing)
return true
}
return false
})
}
}
return
}