-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathcontroller.go
More file actions
1353 lines (1141 loc) · 42.2 KB
/
controller.go
File metadata and controls
1353 lines (1141 loc) · 42.2 KB
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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package controller
import (
"encoding/json"
"errors"
"fmt"
"reflect"
"sort"
"strconv"
"sync"
"github.com/m3db/m3db-operator/pkg/apis/m3dboperator"
myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
clientset "github.com/m3db/m3db-operator/pkg/client/clientset/versioned"
samplescheme "github.com/m3db/m3db-operator/pkg/client/clientset/versioned/scheme"
clusterlisters "github.com/m3db/m3db-operator/pkg/client/listers/m3dboperator/v1alpha1"
"github.com/m3db/m3db-operator/pkg/k8sops/annotations"
"github.com/m3db/m3db-operator/pkg/k8sops/labels"
"github.com/m3db/m3db-operator/pkg/k8sops/m3db"
"github.com/m3db/m3db-operator/pkg/k8sops/podidentity"
"github.com/m3db/m3db-operator/pkg/m3admin"
"github.com/m3db/m3db-operator/pkg/util/eventer"
m3placement "github.com/m3db/m3/src/cluster/placement"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
klabels "k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/clock"
"k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme"
appslisters "k8s.io/client-go/listers/apps/v1"
corelisters "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/utils/pointer"
jsonpatch "github.com/evanphx/json-patch"
pkgerrors "github.com/pkg/errors"
"github.com/uber-go/tally"
"go.uber.org/zap"
)
const (
controllerName = "m3db-controller"
clusterWorkQueueName = "m3dbcluster-work-queue"
podWorkQueueName = "pods-work-queue"
)
var (
errOrphanedPod = errors.New("pod does not belong to an m3db cluster")
errInvalidNumIsoGroups = errors.New("number of isolationgroups not equal to replication factor")
errNonUniqueIsoGroups = errors.New("isolation group names are not unique")
)
// Configuration contains parameters for the controller.
type Configuration struct {
// ManageCRD indicates whether the controller should create and update specs
// of the CRDs it controls.
ManageCRD bool
// EnableValidation controls whether OpenAPI validation is enabled on the CRD.
EnableValidation bool
}
type controllerBase struct {
lock *sync.Mutex
logger *zap.Logger
clock clock.Clock
scope tally.Scope
config Configuration
doneCh chan struct{}
adminClient *multiAdminClient
kubeClient kubernetes.Interface
crdClient clientset.Interface
statefulSetLister appslisters.StatefulSetLister
statefulSetsSynced cache.InformerSynced
podLister corelisters.PodLister
podsSynced cache.InformerSynced
podWorkQueue workqueue.RateLimitingInterface
recorder eventer.Poster
}
// M3DBController object
type M3DBController struct {
controllerBase
k8sclient m3db.K8sops
podIDProvider podidentity.Provider
clusterLister clusterlisters.M3DBClusterLister
clustersSynced cache.InformerSynced
clusterWorkQueue workqueue.RateLimitingInterface
}
// NewM3DBController creates new instance of Controller
func NewM3DBController(opts ...Option) (*M3DBController, error) {
options := &options{}
for _, o := range opts {
o.execute(options)
}
if err := options.validate(); err != nil {
return nil, err
}
kclient := options.kclient
kubeClient := options.kubeClient
crdClient := options.crdClient
scope := options.scope
logger := options.logger
if logger == nil {
logger = zap.NewNop()
}
adminOpts := []m3admin.Option{m3admin.WithLogger(logger)}
multiClient := newMultiAdminClient(adminOpts, logger)
if options.kubectlProxy {
multiClient.clusterURLFn = clusterURLProxy
}
statefulSetInformer := options.filteredInformerFactory.Apps().V1().StatefulSets()
podInformer := options.filteredInformerFactory.Core().V1().Pods()
m3dbClusterInformer := options.m3dbClusterInformerFactory.Operator().V1alpha1().M3DBClusters()
samplescheme.AddToScheme(scheme.Scheme)
clusterWorkQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), clusterWorkQueueName)
podWorkQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), podWorkQueueName)
r, err := eventer.NewEventRecorder(eventer.WithClient(kubeClient), eventer.WithLogger(logger), eventer.WithComponent(controllerName))
if err != nil {
return nil, err
}
p := &M3DBController{
controllerBase: controllerBase{
lock: &sync.Mutex{},
logger: logger,
scope: scope,
config: options.config,
clock: clock.RealClock{},
adminClient: multiClient,
doneCh: make(chan struct{}),
kubeClient: kubeClient,
crdClient: crdClient,
statefulSetLister: statefulSetInformer.Lister(),
statefulSetsSynced: statefulSetInformer.Informer().HasSynced,
podLister: podInformer.Lister(),
podsSynced: podInformer.Informer().HasSynced,
podWorkQueue: podWorkQueue,
// TODO(celina): figure out if we actually need a recorder for each namespace
recorder: r,
},
k8sclient: kclient,
podIDProvider: options.podIDProvider,
clusterLister: m3dbClusterInformer.Lister(),
clustersSynced: m3dbClusterInformer.Informer().HasSynced,
clusterWorkQueue: clusterWorkQueue,
}
m3dbClusterInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: p.enqueueCluster,
UpdateFunc: func(old, new interface{}) {
p.enqueueCluster(new)
},
DeleteFunc: func(obj interface{}) {
// TODO(schallert): what do we want to do on delete? clean up the etcd
// data? we don't need to do anything w/ the sts + pods, we set owner refs
// so kubernetes will GC them for us
logger.Info("deleted cluster")
},
})
statefulSetInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: p.handleStatefulSetUpdate,
UpdateFunc: func(old, new interface{}) {
oldSts := old.(*appsv1.StatefulSet)
newSts := new.(*appsv1.StatefulSet)
// TODO(schallert): version vs. observed generation?
if newSts.ResourceVersion == oldSts.ResourceVersion {
// don't have to reprocess on periodic resync
return
}
p.handleStatefulSetUpdate(new)
},
DeleteFunc: p.handleStatefulSetUpdate,
})
podInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: p.enqueuePod,
UpdateFunc: func(old, new interface{}) {
p.enqueuePod(new)
},
DeleteFunc: func(obj interface{}) {
// No-op
},
})
return p, nil
}
// Run drives the controller event loop.
func (c *M3DBController) Run(nWorkers int, stopCh <-chan struct{}) error {
defer runtime.HandleCrash()
defer c.clusterWorkQueue.ShutDown()
c.logger.Info("starting Operator controller")
if c.config.ManageCRD {
if err := c.k8sclient.CreateOrUpdateCRD(m3dboperator.M3DBClustersName, c.config.EnableValidation); err != nil {
return pkgerrors.WithMessage(err, "could not create or update CRD")
}
}
c.logger.Info("waiting for informer caches to sync")
if ok := cache.WaitForCacheSync(stopCh, c.clustersSynced, c.statefulSetsSynced, c.podsSynced); !ok {
return errors.New("caches failed to sync")
}
c.logger.Info("starting workers")
for i := 0; i < nWorkers; i++ {
go c.runClusterLoop()
go c.runPodLoop()
}
c.logger.Info("workers started")
<-stopCh
c.logger.Info("shutting down workers")
return nil
}
func (c *M3DBController) enqueueCluster(obj interface{}) {
var key string
var err error
if key, err = cache.MetaNamespaceKeyFunc(obj); err != nil {
runtime.HandleError(err)
return
}
c.clusterWorkQueue.AddRateLimited(key)
c.scope.Counter("enqueued_event").Inc(int64(1))
}
func (c *M3DBController) runClusterLoop() {
for c.processClusterQueueItem() {
}
}
func (c *M3DBController) processClusterQueueItem() bool {
obj, shutdown := c.clusterWorkQueue.Get()
c.scope.Counter("dequeued_event").Inc(int64(1))
if shutdown {
return false
}
// Closure so we can defer workQueue.Done.
err := func(obj interface{}) error {
defer c.clusterWorkQueue.Done(obj)
var key string
var ok bool
if key, ok = obj.(string); !ok {
c.clusterWorkQueue.Forget(obj)
runtime.HandleError(fmt.Errorf("expected string from queue, got %#v", obj))
return nil
}
if err := c.handleClusterEvent(key); err != nil {
return fmt.Errorf("error syncing cluster '%s': %v", key, err)
}
c.clusterWorkQueue.Forget(obj)
c.logger.Info("successfully synced item", zap.String("key", key))
return nil
}(obj)
if err != nil {
runtime.HandleError(err)
}
return true
}
func (c *M3DBController) handleClusterEvent(key string) error {
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
runtime.HandleError(fmt.Errorf("invalid resource key: %s", key))
return nil
}
cluster, err := c.clusterLister.M3DBClusters(namespace).Get(name)
if err != nil {
if kerrors.IsNotFound(err) {
// give up processing if this cluster doesn't exist
runtime.HandleError(fmt.Errorf("clusters '%s' no longer exists", key))
return nil
}
return err
}
if cluster == nil {
return errors.New("got nil cluster for " + key)
}
return c.handleClusterUpdate(cluster)
}
// We are guaranteed by handleClusterEvent that we will never be passed a nil
// cluster here.
func (c *M3DBController) handleClusterUpdate(cluster *myspec.M3DBCluster) error {
// MUST create a deep copy of the cluster or risk corrupting cache! Technically
// only need if we modify, but we frequently do that so let's deep copy to
// start and remove unnecessary calls later to optimize if we want.
cluster = cluster.DeepCopy()
clusterLogger := c.logger.With(zap.String("cluster", cluster.Name))
if cluster.Spec.Frozen {
clusterLogger.Info("cluster is frozen so no changes will be made")
return nil
}
// https://v1-12.docs.kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/
//
// If deletion timestamp is zero (cluster hasn't been deleted), make sure our
// finalizer is present. If the cluster has been marked for deletion, delete
// the placement and namespace.
if dts := cluster.ObjectMeta.DeletionTimestamp; dts != nil && !dts.IsZero() {
if !stringArrayContains(cluster.Finalizers, labels.EtcdDeletionFinalizer) {
clusterLogger.Info("no etcd finalizer on cluster, nothing to do")
return nil
}
// If cluster is set to preserve data, jump straight to removing the
// finalizer.
if cluster.Spec.KeepEtcdDataOnDelete {
clusterLogger.Info("skipping etcd deletion due to keepEtcdDataOnDelete")
} else {
if err := c.deleteAllNamespaces(cluster); err != nil {
clusterLogger.Error("error deleting cluster namespaces", zap.Error(err))
return err
}
if err := c.deletePlacement(cluster); err != nil {
clusterLogger.Error("error deleting cluster placement", zap.Error(err))
return err
}
}
if _, err := c.removeEtcdFinalizer(cluster); err != nil {
clusterLogger.Error("error deleting etcd finalizer", zap.Error(err))
return pkgerrors.WithMessage(err, "error removing etcd cluster finalizer")
}
// Exit the control loop once the cluster is deleted and cleaned up.
clusterLogger.Info("completed finalizer cleanup")
return nil
}
if err := validateIsolationGroups(cluster); err != nil {
clusterLogger.Error("failed validating isolationgroups", zap.Error(err))
c.recorder.WarningEvent(cluster, eventer.ReasonFailSync, err.Error())
return err
}
if !cluster.Spec.KeepEtcdDataOnDelete {
var err error
cluster, err = c.ensureEtcdFinalizer(cluster)
if err != nil {
return err
}
}
if err := c.ensureConfigMap(cluster); err != nil {
clusterLogger.Error("failed to ensure configmap", zap.Error(err))
c.recorder.WarningEvent(cluster, eventer.ReasonFailSync, "failed to ensure configmap: %s", err.Error())
return err
}
// Per https://v1-10.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#statefulsetspec-v1-apps,
// headless service MUST exist before statefulset.
if err := c.ensureServices(cluster); err != nil {
return err
}
if len(cluster.Spec.IsolationGroups) == 0 {
// nothing to do, no groups to create in
return nil
}
// copy since we sort the array
isoGroups := make([]myspec.IsolationGroup, len(cluster.Spec.IsolationGroups))
copy(isoGroups, cluster.Spec.IsolationGroups)
sort.Sort(myspec.IsolationGroups(isoGroups))
childrenSets, err := c.getChildStatefulSets(cluster)
if err != nil {
return err
}
childrenSetsByName := make(map[string]*appsv1.StatefulSet)
for _, sts := range childrenSets {
childrenSetsByName[sts.Name] = sts
}
// Create any missing statefulsets, at this point all existing stateful sets are bootstrapped.
for i := 0; i < len(isoGroups); i++ {
name := m3db.StatefulSetName(cluster.Name, i)
_, exists := childrenSetsByName[name]
if !exists {
sts, err := m3db.GenerateStatefulSet(cluster, isoGroups[i].Name, isoGroups[i].NumInstances)
if err != nil {
return err
}
_, err = c.kubeClient.AppsV1().StatefulSets(cluster.Namespace).Create(sts)
if err != nil {
if kerrors.IsAlreadyExists(err) {
// There may be a delay between when a StatefulSet is created and when it is
// returned in calls to List because of the caching that the k8s client does.
// So if we receive an error because the StatefulSet already exists that's not
// indicative of a real problem.
c.logger.Info("statefulset already exists", zap.String("name", name))
return nil
}
c.logger.Error(err.Error())
return err
}
c.logger.Info("created statefulset", zap.String("name", name))
return nil
}
}
// For all statefulsets, ensure their observered generation is up to date.
// This means that the k8s statefulset controller has updated Status (and
// therefore ready replicas + updated replicas). If observed generation !=
// generation, it means Status will contain stale info.
for _, sts := range childrenSets {
if sts.Generation != sts.Status.ObservedGeneration {
c.logger.Warn("stateful set not up to date",
zap.String("namespace", sts.Namespace),
zap.String("name", sts.Name),
zap.Int32("readyReplicas", sts.Status.ReadyReplicas),
zap.Int32("updatedReplicas", sts.Status.UpdatedReplicas),
zap.String("currentRevision", sts.Status.CurrentRevision),
zap.String("updateRevision", sts.Status.UpdateRevision),
zap.Int64("generation", sts.Generation),
zap.Int64("observed", sts.Status.ObservedGeneration),
)
return fmt.Errorf("set %s generation is not up to date (current: %d, observed: %d)", sts.Name, sts.Generation, sts.Status.ObservedGeneration)
}
}
// If any of the statefulsets aren't ready, wait until they are as we'll get
// another event (ready == bootstrapped)
for _, sts := range childrenSets {
c.logger.Debug("processing set",
zap.String("namespace", sts.Namespace),
zap.String("name", sts.Name),
zap.Int32("readyReplicas", sts.Status.ReadyReplicas),
zap.Int32("updatedReplicas", sts.Status.UpdatedReplicas),
zap.String("currentRevision", sts.Status.CurrentRevision),
zap.String("updateRevision", sts.Status.UpdateRevision),
zap.Int64("generation", sts.Generation),
zap.Int64("observed", sts.Status.ObservedGeneration),
)
if sts.Spec.Replicas == nil {
c.logger.Warn("skip check for statefulset, replicas is nil",
zap.String("name", sts.Name),
zap.Int32("readyReplicas", sts.Status.ReadyReplicas),
zap.Int32("updatedReplicas", sts.Status.UpdatedReplicas),
zap.String("currentRevision", sts.Status.CurrentRevision),
zap.String("updateRevision", sts.Status.UpdateRevision))
continue
}
replicas := *sts.Spec.Replicas
ready := replicas == sts.Status.ReadyReplicas
if sts.Status.UpdateRevision != "" &&
sts.Spec.UpdateStrategy.Type == appsv1.RollingUpdateStatefulSetStrategyType {
// If there is an update revision, ensure all pods are updated
// otherwise there is a rollout in progress.
// Note: This ensures there is no race condition between
// updating a stateful set and it seemingly being "ready" and
// all pods healthy immediately after the update, since the
// updated replicas will not match the desired replicas
// and avoid the race condition of proceeding to another update
// before a stateful set has had a chance to update the pods
// but otherwise seemingly is healthy.
ready = ready && replicas == sts.Status.UpdatedReplicas
}
if !ready {
c.logger.Info("waiting for statefulset to be ready",
zap.String("namespace", sts.Namespace),
zap.String("name", sts.Name),
zap.Int32("replicas", replicas),
zap.Int32("readyReplicas", sts.Status.ReadyReplicas),
zap.Int32("updatedReplicas", sts.Status.UpdatedReplicas),
zap.String("currentRevision", sts.Status.CurrentRevision),
zap.String("updateRevision", sts.Status.UpdateRevision))
return nil
}
}
// Now that we know the cluster is healthy, iterate over each isolation group and check
// if it should be updated.
for i := 0; i < len(isoGroups); i++ {
name := m3db.StatefulSetName(cluster.Name, i)
// This StatefulSet is guaranteed to exist since if it didn't originally it would be
// created above when we first iterate over the isolation groups.
actual := childrenSetsByName[name]
expected, update, err := updatedStatefulSet(actual, cluster, isoGroups[i])
if err != nil {
c.logger.Error(err.Error())
return err
}
// If we're not updating the statefulset AND we're not using the OnDelete update
// strategy, then move to the next statefulset. When using the OnDelete update
// strategy, we still may want to restart nodes for this particular statefulset,
// so don't continue yet.
onDeleteUpdateStrategy :=
actual.Spec.UpdateStrategy.Type == appsv1.OnDeleteStatefulSetStrategyType
if !update && !onDeleteUpdateStrategy {
continue
}
if update {
_, err = c.applyStatefulSetUpdate(cluster, actual, expected)
if err != nil {
c.logger.Error(err.Error())
return err
}
return nil
}
// Using an OnDelete strategy, we have to update nodes if:
// - a statefulset update has happened OR
// - we're already in the middle of a rollout
// * because nodes are rolled out in chunks, this can happen over many iterations
// Therefore, check to see if pods need to be updated and return from this loop
// if pods were updated. If a rollout is finished or there has not
// been a change, this call is a no-op.
if onDeleteUpdateStrategy {
nodesUpdated, err := c.updateStatefulSetPods(cluster, actual)
if err != nil {
c.logger.Error("error performing update",
zap.Error(err),
zap.String("namespace", cluster.Namespace),
zap.String("name", actual.Name))
return err
}
// If we've performed any updates at all, do not process the next statefulset.
// Wait for the updated pods to become healthy.
if nodesUpdated {
return nil
}
}
}
if !cluster.Status.HasInitializedPlacement() {
cluster, err = c.validatePlacementWithStatus(cluster)
if err != nil {
return err
}
}
if err := c.reconcileNamespaces(cluster); err != nil {
c.recorder.WarningEvent(cluster, eventer.ReasonFailedCreate, "failed to create namespace: %s", err)
c.logger.Error("error reconciling namespaces", zap.Error(err))
return err
}
if len(cluster.Spec.Namespaces) == 0 {
c.logger.Warn("cluster has no namespaces defined", zap.String("cluster", cluster.Name))
c.recorder.WarningEvent(cluster, eventer.ReasonUnknown, "cluster %s has no namespaces", cluster.Name)
}
// At this point we have the desired number of statefulsets, and every pod
// across those sets is bootstrapped. However some may be bootstrapped because
// they own no shards. Check to see that all pods are in the placement.
clusterPodsSelector := klabels.SelectorFromSet(labels.BaseLabels(cluster))
pods, err := c.podLister.Pods(cluster.Namespace).List(clusterPodsSelector)
if err != nil {
return fmt.Errorf("error listing pods to construct placement: %v", err)
}
placement, err := c.adminClient.placementClientForCluster(cluster).Get()
if err != nil {
return fmt.Errorf("error fetching active placement: %v", err)
}
c.logger.Info("found placement", zap.Int("currentPods", len(pods)), zap.Int("placementInsts", placement.NumInstances()))
unavailInsts := []string{}
for _, inst := range placement.Instances() {
if !inst.IsAvailable() {
unavailInsts = append(unavailInsts, inst.ID())
}
}
if ln := len(unavailInsts); ln > 0 {
c.logger.Warn("waiting for instances to be available", zap.Strings("instances", unavailInsts))
c.recorder.WarningEvent(cluster, eventer.ReasonLongerThanUsual, "current unavailable instances: %d", ln)
return nil
}
// Determine if any sets aren't at their desired replica count. Maybe we can
// reuse the set objects from above but being paranoid for now.
childrenSets, err = c.getChildStatefulSets(cluster)
if err != nil {
return err
}
// check if any pods inside the cluster need to be swapped in
leavingInstanceID, podToReplace, err := c.checkPodsForReplacement(cluster, pods, placement)
if err != nil {
return err
}
if podToReplace != nil {
err = c.replacePodInPlacement(cluster, placement, leavingInstanceID, podToReplace)
if err != nil {
c.recorder.WarningEvent(cluster, eventer.ReasonFailedToUpdate, "could not replace instance: "+leavingInstanceID)
return err
}
c.recorder.NormalEvent(cluster, eventer.ReasonSuccessfulUpdate, "successfully replaced instance: "+leavingInstanceID)
}
for _, set := range childrenSets {
zone, ok := set.Labels[labels.IsolationGroup]
if !ok {
return fmt.Errorf("statefulset %s has no isolation-group label", set.Name)
}
group, ok := myspec.IsolationGroups(isoGroups).GetByName(zone)
if !ok {
return fmt.Errorf("zone %s not found in cluster isoGroups %v", zone, isoGroups)
}
if set.Spec.Replicas == nil {
return fmt.Errorf("set %s has unset spec replica", set.Name)
}
// Number of pods we want in the group.
desired := group.NumInstances
// Number of pods currently in the group.
current := *set.Spec.Replicas
// Number of instances in the group AND currently in the placement.
inPlacement := int32(len(instancesInIsoGroup(placement, group.Name)))
setLogger := c.logger.With(
zap.String("statefulSet", set.Name),
zap.Int32("inPlacement", inPlacement),
zap.Int32("current", current),
zap.Int32("desired", desired),
)
if desired == current {
// If the set is at its desired size, and all pods in the set are in the
// placement, there's nothing we need to do for this set.
if current == inPlacement {
continue
}
// If the set is at its desired size but there's pods in the set that are
// absent from the placement, add pods to placement.
if inPlacement < current {
setLogger.Info("expanding placement for set")
return c.expandPlacementForSet(cluster, set, group, placement)
}
}
// If there are more pods in the placement than we want in the group,
// trigger a remove so that we can shrink the set.
if inPlacement > desired {
setLogger.Info("remove instance from placement for set")
return c.shrinkPlacementForSet(cluster, set, placement)
}
var newCount int32
if current < desired {
newCount = current + 1
} else {
newCount = current - 1
}
setLogger.Info("resizing set, desired != current", zap.Int32("newSize", newCount))
if err = c.patchStatefulSet(set, func(set *appsv1.StatefulSet) {
set.Spec.Replicas = pointer.Int32Ptr(newCount)
}); err != nil {
c.logger.Error("error patching statefulset", zap.Error(err))
return err
}
return nil
}
placement, err = c.adminClient.placementClientForCluster(cluster).Get()
if err != nil {
return fmt.Errorf("error fetching placement: %v", err)
}
// TODO(celina): possibly do a replacement check here
// See if we need to clean up the pod bootstrapping status.
cluster, err = c.reconcileBootstrappingStatus(cluster, placement)
if err != nil {
return fmt.Errorf("error reconciling bootstrap status: %v", err)
}
c.logger.Info("nothing to do",
zap.Int("childrensets", len(childrenSets)),
zap.Int("zones", len(isoGroups)),
zap.Int64("generation", cluster.ObjectMeta.Generation),
zap.String("rv", cluster.ObjectMeta.ResourceVersion))
return nil
}
func (c *M3DBController) patchStatefulSet(
set *appsv1.StatefulSet,
action func(set *appsv1.StatefulSet),
) error {
setBytes, err := json.Marshal(set)
if err != nil {
return err
}
action(set)
setModifiedBytes, err := json.Marshal(set)
if err != nil {
return err
}
patchBytes, err := jsonpatch.CreateMergePatch(setBytes, setModifiedBytes)
if err != nil {
return err
}
set, err = c.kubeClient.
AppsV1().
StatefulSets(set.Namespace).
Patch(set.Name, types.MergePatchType, patchBytes)
if err != nil {
return fmt.Errorf("error updating statefulset %s: %w", set.Name, err)
}
return nil
}
func (c *M3DBController) applyStatefulSetUpdate(
cluster *myspec.M3DBCluster,
actual *appsv1.StatefulSet,
expected *appsv1.StatefulSet,
) (*appsv1.StatefulSet, error) {
updated, err := c.kubeClient.AppsV1().StatefulSets(cluster.Namespace).Update(expected)
if err != nil {
c.logger.Error(err.Error())
return nil, err
}
c.logger.Info("updated statefulset",
zap.String("name", expected.Name),
zap.Int32("actual_readyReplicas", actual.Status.ReadyReplicas),
zap.Int32("actual_updatedReplicas", actual.Status.UpdatedReplicas),
zap.String("actual_currentRevision", actual.Status.CurrentRevision),
zap.String("actual_updateRevision", actual.Status.UpdateRevision),
zap.Int32("expected_readyReplicas", expected.Status.ReadyReplicas),
zap.Int32("expected_updatedReplicas", expected.Status.UpdatedReplicas),
zap.String("expected_currentRevision", expected.Status.CurrentRevision),
zap.String("expected_updateRevision", expected.Status.UpdateRevision),
zap.Int64("generation", expected.Generation),
zap.Int64("observed", expected.Status.ObservedGeneration),
)
return updated, nil
}
// updateStatefulSetPods returns true if it updates any pods
func (c *M3DBController) updateStatefulSetPods(
cluster *myspec.M3DBCluster,
sts *appsv1.StatefulSet,
) (bool, error) {
logger := c.logger.With(
zap.String("namespace", cluster.Namespace), zap.String("name", sts.Name),
)
if _, ok := sts.Annotations[annotations.ParallelUpdateInProgress]; !ok {
logger.Debug("no update and no rollout in progress so move to next statefulset")
return false, nil
}
numPods, err := getMaxPodsToUpdate(sts)
if err != nil {
return false, err
}
if numPods == 0 {
return false, errors.New("parallel update annotation set to 0. will not perform pod updates")
}
pods, err := c.podsToUpdate(cluster.Namespace, sts, numPods)
if err != nil {
return false, err
}
if len(pods) > 0 {
names := make([]string, 0, len(pods))
for _, pod := range pods {
if err := c.kubeClient.CoreV1().
Pods(pod.Namespace).
Delete(pod.Name, &metav1.DeleteOptions{}); err != nil {
return false, err
}
names = append(names, pod.Name)
}
logger.Info("restarting pods", zap.Strings("pods", names))
return true, nil
}
// If there are no pods to update, we're fully rolled out so remove
// the update annotation and update status.
//
// NB(nate): K8s handles this for you when using the RollingUpdate update strategy.
// However, since OnDelete removes k8s from the pod update process, it's our
// responsibility to set this once done rolling out.
sts.Status.CurrentReplicas = sts.Status.UpdatedReplicas
sts.Status.CurrentRevision = sts.Status.UpdateRevision
if sts, err = c.kubeClient.AppsV1().StatefulSets(cluster.Namespace).UpdateStatus(sts); err != nil {
return false, err
}
if err = c.patchStatefulSet(sts, func(set *appsv1.StatefulSet) {
delete(set.Annotations, annotations.ParallelUpdateInProgress)
}); err != nil {
return false, err
}
logger.Info("update complete")
return false, nil
}
func getMaxPodsToUpdate(actual *appsv1.StatefulSet) (int, error) {
var (
rawVal string
ok bool
)
if rawVal, ok = actual.Annotations[annotations.ParallelUpdateInProgress]; !ok {
return 0, errors.New("parallel update annotation missing during statefulset update")
}
var (
maxPodsPerUpdate int
err error
)
if maxPodsPerUpdate, err = strconv.Atoi(rawVal); err != nil {
return 0, fmt.Errorf("failed to parse parallel update annotation: %v", rawVal)
}
return maxPodsPerUpdate, nil
}
func (c *M3DBController) podsToUpdate(
namespace string,
sts *appsv1.StatefulSet,
numPods int,
) ([]*corev1.Pod, error) {
var (
currRev = sts.Status.CurrentRevision
updateRev = sts.Status.UpdateRevision
)
// nolint:gocritic
if currRev == "" {
return nil, errors.New("currentRevision empty")
} else if updateRev == "" {
return nil, errors.New("updateRevision empty")
} else if currRev == updateRev {
// No pods to update because current and update revision are the same
return nil, nil
}
// Get any pods not on the updateRevision for this statefulset
podSelector, err := generatePodSelector(updateRev, sts)
if err != nil {
return nil, err
}
pods, err := c.podLister.Pods(namespace).List(podSelector)
if err != nil {
return nil, err
} else if len(pods) == 0 {
return nil, nil
}
// NB(nate): Sort here so updates are always done in a consistent order.
// Statefulset 0 -> N: Pod 0 -> N
sortedPods, err := sortPods(pods)
if err != nil {
return nil, err
}
toUpdate := make([]*corev1.Pod, 0, len(sortedPods))
for _, pod := range sortedPods {
toUpdate = append(toUpdate, pod.pod)
if len(toUpdate) == numPods {
break
}
}
return toUpdate, nil
}
func generatePodSelector(updateRev string, sts *appsv1.StatefulSet) (klabels.Selector, error) {
revReq, err := klabels.NewRequirement(
"controller-revision-hash", selection.NotEquals, []string{updateRev},
)
if err != nil {
return nil, err
}
stsReq, err := klabels.NewRequirement(
labels.StatefulSet, selection.Equals, []string{sts.Name},
)
if err != nil {
return nil, err
}
podSelector := klabels.NewSelector().Add(*revReq, *stsReq)
return podSelector, nil
}
func instancesInIsoGroup(pl m3placement.Placement, isoGroup string) []m3placement.Instance {
insts := []m3placement.Instance{}
for _, inst := range pl.Instances() {
if inst.IsolationGroup() == isoGroup {
insts = append(insts, inst)
}
}
return insts
}
// This func is currently read-only, but if we end up modifying statefulsets
// we'll have to deepcopy.
func (c *M3DBController) getChildStatefulSets(cluster *myspec.M3DBCluster) ([]*appsv1.StatefulSet, error) {
labels := labels.BaseLabels(cluster)
statefulSets, err := c.statefulSetLister.StatefulSets(cluster.Namespace).List(klabels.Set(labels).AsSelector())
if err != nil {
runtime.HandleError(fmt.Errorf("error listing statefulsets: %v", err))
return nil, err
}
childrenSets := make([]*appsv1.StatefulSet, 0)