-
Notifications
You must be signed in to change notification settings - Fork 10
/
canary.go
519 lines (445 loc) · 15.3 KB
/
canary.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
package controller
import (
"fmt"
"reflect"
"sort"
"strings"
"time"
"github.com/caicloud/canary-release/controller/config"
"github.com/caicloud/canary-release/pkg/api"
"github.com/caicloud/canary-release/pkg/util"
"github.com/caicloud/clientset/informers"
"github.com/caicloud/clientset/kubernetes"
releaselisters "github.com/caicloud/clientset/listers/release/v1alpha1"
apiextensions "github.com/caicloud/clientset/pkg/apis/apiextensions/v1beta1"
releaseapi "github.com/caicloud/clientset/pkg/apis/release/v1alpha1"
controllerutil "github.com/caicloud/clientset/util/controller"
"github.com/caicloud/clientset/util/syncqueue"
log "github.com/zoumo/logdog"
apps "k8s.io/api/apps/v1"
core "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/types"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
appsv1 "k8s.io/client-go/listers/apps/v1"
corev1 "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
)
const (
proxyNameSuffix = "-proxy"
)
var (
// controllerKind contains the schema.GroupVersionKind for this controller type.
controllerKind = releaseapi.SchemeGroupVersion.WithKind(api.CanaryReleaseKind)
)
// CanaryReleaseController ...
type CanaryReleaseController struct {
proxyImage string
client kubernetes.Interface
// crdclient apiextensionsclient.Interface
factory informers.SharedInformerFactory
crLister releaselisters.CanaryReleaseLister
rLister releaselisters.ReleaseLister
dLister appsv1.DeploymentLister
podLister corev1.PodLister
queue *syncqueue.SyncQueue
}
// NewCanaryReleaseController creates a new CanaryReleaseController
func NewCanaryReleaseController(cfg config.Configuration) *CanaryReleaseController {
factory := informers.NewSharedInformerFactory(cfg.Client, 0)
crinformer := factory.Release().V1alpha1().CanaryReleases()
rinformer := factory.Release().V1alpha1().Releases()
dinformer := factory.Apps().V1().Deployments()
podinformer := factory.Core().V1().Pods()
crc := &CanaryReleaseController{
proxyImage: cfg.Proxy.Image,
client: cfg.Client,
factory: factory,
crLister: crinformer.Lister(),
rLister: rinformer.Lister(),
dLister: dinformer.Lister(),
podLister: podinformer.Lister(),
}
crc.queue = syncqueue.NewPassthroughSyncQueue(&releaseapi.CanaryRelease{}, crc.syncCanaryRelease)
crinformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: crc.addCanaryRelease,
UpdateFunc: crc.updateCanaryRelease,
DeleteFunc: crc.deleteCanaryRelease,
})
rinformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
DeleteFunc: crc.deleteRelease,
})
podinformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: crc.addPod,
UpdateFunc: crc.updatePod,
DeleteFunc: crc.deletePod,
})
return crc
}
// Run ...
func (crc *CanaryReleaseController) Run(workers int, stopCh <-chan struct{}) {
defer utilruntime.HandleCrash()
log.Info("Startting canary release controller")
defer log.Info("Shutting down canary release controller")
if err := crc.ensureResource(); err != nil {
log.Error("Error ensure canary release", log.Fields{"err": err})
return
}
log.Info("Startting informer factory")
crc.factory.Start(stopCh)
log.Info("Wart for all caches synced")
synced := crc.factory.WaitForCacheSync(stopCh)
for tpy, sync := range synced {
if !sync {
log.Error("Wait for cache sync timeout", log.Fields{"type": tpy})
return
}
}
log.Info("All cahces have synced, Running Canary Release Controller ...", log.Fields{"worker": workers})
// start workers
crc.queue.Run(workers)
defer func() {
log.Info("Shutting down controller queue")
crc.queue.ShutDown()
}()
<-stopCh
}
func (crc *CanaryReleaseController) ensureResource() error {
cr := &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "canaryreleases." + releaseapi.GroupName,
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: releaseapi.GroupName,
Version: "v1alpha1",
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "canaryreleases",
Singular: "canaryrelease",
Kind: "CanaryRelease",
ListKind: "CanaryReleaseList",
},
},
}
_, err := crc.client.ApiextensionsV1beta1().CustomResourceDefinitions().Create(cr)
if errors.IsAlreadyExists(err) {
log.Info("Skip the creation for CustomResourceDefinition CanaryRelease because it has already been created")
return nil
}
if err != nil {
return err
}
log.Info("Create CustomResourceDefinition CanaryRelease successfully")
return nil
}
func (crc *CanaryReleaseController) selector(cr *releaseapi.CanaryRelease) labels.Set {
return labels.Set{
api.LabelKeyCreatedBy: fmt.Sprintf(api.LabelValueFormatCreateby, cr.Namespace, cr.Name),
}
}
func (crc *CanaryReleaseController) syncCanaryRelease(obj interface{}) error {
// type assertion
cr, ok := obj.(*releaseapi.CanaryRelease)
if !ok {
return fmt.Errorf("expect canary release, got:%v", obj)
}
// get obj key
key, _ := cache.DeletionHandlingMetaNamespaceKeyFunc(cr)
// record time
startTime := time.Now()
defer func() {
log.Debug("Finished syncing canary release", log.Fields{"cr": key, "usedTime": time.Since(startTime)})
}()
// find obj in local store
ncr, err := crc.crLister.CanaryReleases(cr.Namespace).Get(cr.Name)
if errors.IsNotFound(err) {
log.Warn("CanaryRelease has been deleted, clean up", log.Fields{"cr": key})
return crc.cleanup(cr)
}
if err != nil {
utilruntime.HandleError(fmt.Errorf("Unable to retrieve CanaryRelease %v from store: %v", key, err))
return err
}
// fresh cr
if cr.UID != ncr.UID {
// original canary release is gone
return nil
}
// canary release
if ncr.DeletionTimestamp != nil {
return nil
}
cr = ncr.DeepCopy()
// only if the canary release status clearly point out it finished transition
// then we can cleanup it
if cr.Status.Phase != releaseapi.CanaryTrasitionNone {
log.Info("detected a adopted/deprecated Cananry Release, cleanup it", log.Fields{"cr": key})
return crc.cleanup(cr)
}
// find related release
release, err := crc.rLister.Releases(cr.Namespace).Get(cr.Spec.Release)
if errors.IsNotFound(err) {
// if release has been deleted, delete this canary release
log.Info("Release has been deleted, delete this CanaryRelease", log.Fields{"cr": key})
return crc.delete(cr)
}
if err != nil {
utilruntime.HandleError(fmt.Errorf("Unable to retrieve Release %v from store: %v", key, err))
return err
}
// if release.version != canary.version, skip it
if release.Status.Version != cr.Spec.Version {
log.Info("Release.Version != CanaryRelease.Version deprecate this CanaryRelease", log.Fields{"release.version": release.Status.Version, "canary.version": cr.Spec.Version})
return crc.deprecate(cr)
}
ds, err := crc.getDeploymentsForCanaryRelease(cr)
if err != nil {
return err
}
return crc.sync(cr, ds)
}
func (crc *CanaryReleaseController) deprecate(cr *releaseapi.CanaryRelease) error {
if cr.Spec.Transition != releaseapi.CanaryTrasitionNone {
return nil
}
patch := fmt.Sprintf(`{"spec": {"transition": "%s"}}`, releaseapi.CanaryTrasitionDeprecated)
_, err := crc.client.ReleaseV1alpha1().CanaryReleases(cr.Namespace).Patch(cr.Name, types.MergePatchType, []byte(patch))
return err
}
func (crc *CanaryReleaseController) delete(cr *releaseapi.CanaryRelease) error {
return crc.client.ReleaseV1alpha1().CanaryReleases(cr.Namespace).Delete(cr.Name, &metav1.DeleteOptions{})
}
func (crc *CanaryReleaseController) cleanup(cr *releaseapi.CanaryRelease) error {
ds, err := crc.getDeploymentsForCanaryRelease(cr)
if err != nil {
return err
}
policy := metav1.DeletePropagationBackground
gracePeriodSeconds := int64(60)
for _, d := range ds {
err = crc.client.AppsV1().Deployments(d.Namespace).Delete(d.Name, &metav1.DeleteOptions{
GracePeriodSeconds: &gracePeriodSeconds,
PropagationPolicy: &policy,
})
if err != nil {
log.Warn("Error clean up canary release", log.Fields{"d.ns": d.Namespace, "d.name": d.Name, "err": err})
return err
}
}
return nil
}
func (crc *CanaryReleaseController) sync(cr *releaseapi.CanaryRelease, dps []*apps.Deployment) error {
desiredDeploy := crc.generateDeployment(cr)
var err error
updated := false
activeDeploy := desiredDeploy
for _, dp := range dps {
// two conditions will trigger controller to scale down deployment
// 1. deployment does not have auto-generated prefix
// 2. if there are more than one active controllers, there may be many valid deployments.
// But we only need one.
if !strings.HasPrefix(dp.Name, cr.Name+proxyNameSuffix) || updated {
log.Warn("Delete unexpected proxy", log.Fields{"dp.name": dp.Name, "cr.name": cr.Name})
crc.client.AppsV1().Deployments(dp.Namespace).Delete(dp.Name, &metav1.DeleteOptions{})
continue
}
updated = true
activeDeploy = dp
// no need to update, let proxy do it
}
if !updated {
crc.addCondition(cr, api.NewCondition(api.ReasonCreating, ""))
log.Info("Create proxy for canary release", log.Fields{"dp.name": desiredDeploy.Name, "cr.name": cr.Name})
_, err = crc.client.AppsV1().Deployments(cr.Namespace).Create(desiredDeploy)
if err != nil {
return err
}
}
return crc.syncStatus(cr, activeDeploy)
}
func (crc *CanaryReleaseController) addCanaryRelease(obj interface{}) {
cr := obj.(*releaseapi.CanaryRelease)
if cr.DeletionTimestamp != nil {
// On a restart of the controller manager, it's possible for an object to
// show up in a state that is already pending deletion.
crc.deleteCanaryRelease(cr)
return
}
log.Info("Adding CanaryRelaese", log.Fields{"name": cr.Name})
crc.queue.Enqueue(cr)
}
func (crc *CanaryReleaseController) updateCanaryRelease(oldObj, curObj interface{}) {
old := oldObj.(*releaseapi.CanaryRelease)
cur := curObj.(*releaseapi.CanaryRelease)
if old.ResourceVersion == cur.ResourceVersion {
// Periodic resync will send update events for all known Objects.
// Two different versions of the same Objects will always have different RVs.
return
}
// if status.Phase is changed to Adopted or Deprecated, we need to
// clean up the proxy
if reflect.DeepEqual(old.Spec, cur.Spec) && old.Status.Phase == cur.Status.Phase {
return
}
log.Info("Updating CanaryRelease", log.Fields{"name": old.Name})
crc.queue.EnqueueAfter(cur, 1*time.Second)
}
func (crc *CanaryReleaseController) deleteCanaryRelease(obj interface{}) {
cr, ok := obj.(*releaseapi.CanaryRelease)
if !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
utilruntime.HandleError(fmt.Errorf("Couldn't get object from tombstone %#v", obj))
return
}
cr, ok = tombstone.Obj.(*releaseapi.CanaryRelease)
if !ok {
utilruntime.HandleError(fmt.Errorf("Tombstone contained object that is not a CanaryRelease %#v", obj))
return
}
}
log.Info("Deleting CanaryRelease", log.Fields{"cr.name": cr.Name, "cr.ns": cr.Namespace})
crc.queue.Enqueue(cr)
}
func (crc *CanaryReleaseController) deleteRelease(obj interface{}) {
release, ok := obj.(*releaseapi.Release)
if !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
utilruntime.HandleError(fmt.Errorf("Couldn't get object from tombstone %#v", obj))
return
}
release, ok = tombstone.Obj.(*releaseapi.Release)
if !ok {
utilruntime.HandleError(fmt.Errorf("Tombstone contained object that is not a CanaryRelease %#v", obj))
return
}
}
crs, err := crc.crLister.CanaryReleases(release.Namespace).List(labels.Everything())
if err != nil {
return
}
for _, cr := range crs {
if cr.Spec.Release == release.Name {
crc.queue.Enqueue(cr)
}
}
}
func (crc *CanaryReleaseController) getDeploymentsForCanaryRelease(cr *releaseapi.CanaryRelease) ([]*apps.Deployment, error) {
// construct selector
selector := crc.selector(cr).AsSelector()
// list all
dList, err := crc.dLister.Deployments(cr.Namespace).List(selector)
if err != nil {
return nil, err
}
// If any adoptions are attempted, we should first recheck for deletion with
// an uncached quorum read sometime after listing deployment (see kubernetes#42639).
canAdoptFunc := RecheckDeletionTimestamp(func() (metav1.Object, error) {
// fresh lb
fresh, err := crc.client.ReleaseV1alpha1().CanaryReleases(cr.Namespace).Get(cr.Name, metav1.GetOptions{})
if err != nil {
return nil, err
}
if fresh.UID != cr.UID {
return nil, fmt.Errorf("original CanaryRelease %v/%v is gone: got uid %v, wanted %v", cr.Namespace, cr.Name, fresh.UID, cr.UID)
}
return fresh, nil
})
cm := controllerutil.NewDeploymentControllerRefManager(crc.client, cr, selector, controllerKind, canAdoptFunc)
result, err := cm.Claim(dList)
if err == nil {
// sort deployments
ret := sortByName(result)
sort.Sort(ret)
result = []*apps.Deployment(ret)
}
return result, err
}
func (crc *CanaryReleaseController) generateDeployment(cr *releaseapi.CanaryRelease) *apps.Deployment {
terminationGraPeridSeconds := int64(60)
labels := crc.selector(cr)
t := true
replicas := int32(1)
deploy := &apps.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: cr.Name + proxyNameSuffix,
Labels: labels,
OwnerReferences: []metav1.OwnerReference{
{
APIVersion: controllerKind.GroupVersion().String(),
Kind: controllerKind.Kind,
Name: cr.Name,
UID: cr.UID,
Controller: &t,
BlockOwnerDeletion: &t,
},
},
},
Spec: apps.DeploymentSpec{
Replicas: &replicas,
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: core.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
},
Spec: core.PodSpec{
TerminationGracePeriodSeconds: &terminationGraPeridSeconds,
Containers: []core.Container{
{
Name: "canary-release-proxy",
Image: crc.proxyImage,
Resources: cr.Spec.Resources,
Env: []core.EnvVar{
{
Name: "CANARY_RELEASE_NAME",
Value: cr.Name,
},
{
Name: "CANARY_RELEASE_NAMESPACE",
Value: cr.Namespace,
},
{
Name: "RELEASE_NAME",
Value: cr.Spec.Release,
},
},
},
},
},
},
},
}
return deploy
}
// RecheckDeletionTimestamp returns a canAdopt() function to recheck deletion.
//
// The canAdopt() function calls getObject() to fetch the latest value,
// and denies adoption attempts if that object has a non-nil DeletionTimestamp.
func RecheckDeletionTimestamp(getObject func() (metav1.Object, error)) func() error {
return func() error {
obj, err := getObject()
if err != nil {
return fmt.Errorf("can't recheck DeletionTimestamp: %v", err)
}
if obj.GetDeletionTimestamp() != nil {
return fmt.Errorf("%v/%v has just been deleted at %v", obj.GetNamespace(), obj.GetName(), obj.GetDeletionTimestamp())
}
return nil
}
}
func (crc *CanaryReleaseController) addCondition(cr *releaseapi.CanaryRelease, condition releaseapi.CanaryReleaseCondition) error {
apply := func(cr *releaseapi.CanaryRelease) error {
cr.Status.Conditions = append(cr.Status.Conditions, condition)
return nil
}
_, err := util.UpdateCRWithRetries(crc.client.ReleaseV1alpha1().CanaryReleases(cr.Namespace), crc.crLister, cr.Namespace, cr.Name, apply)
return err
}
func (crc *CanaryReleaseController) addErrorCondition(cr *releaseapi.CanaryRelease, err error) error {
return crc.addCondition(cr, api.NewConditionFrom(err))
}