-
Notifications
You must be signed in to change notification settings - Fork 73
/
reconcile_tablets.go
448 lines (380 loc) · 17 KB
/
reconcile_tablets.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
/*
Copyright 2019 PlanetScale Inc.
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 vitessshard
import (
"context"
"sort"
"strconv"
"time"
topodatapb "vitess.io/vitess/go/vt/proto/topodata"
"vitess.io/vitess/go/vt/topo/topoproto"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
podutil "k8s.io/kubernetes/pkg/api/v1/pod"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
planetscalev2 "planetscale.dev/vitess-operator/pkg/apis/planetscale/v2"
"planetscale.dev/vitess-operator/pkg/operator/drain"
"planetscale.dev/vitess-operator/pkg/operator/k8s"
"planetscale.dev/vitess-operator/pkg/operator/reconciler"
"planetscale.dev/vitess-operator/pkg/operator/results"
"planetscale.dev/vitess-operator/pkg/operator/rollout"
"planetscale.dev/vitess-operator/pkg/operator/toposerver"
"planetscale.dev/vitess-operator/pkg/operator/update"
"planetscale.dev/vitess-operator/pkg/operator/vttablet"
)
const (
// tabletAvailableTime is how long a tablet Pod must be consistently Ready
// before it is considered Available. This accounts for the time it takes
// for vtgates to discover that the tablet is Ready and update their routing
// tables. If a tablet is Ready but vtgates don't know it yet, then it isn't
// actually available for serving queries yet.
tabletAvailableTime = 30 * time.Second
// observedShardGenerationAnnotationKey is used to set the shard generation
// that is observed at the time an UpdateInPlace is called for a pod.
observedShardGenerationAnnotationKey = "planetscale.com/observed-shard-generation"
)
func (r *ReconcileVitessShard) reconcileTablets(ctx context.Context, vts *planetscalev2.VitessShard) (reconcile.Result, error) {
resultBuilder := &results.Builder{}
clusterName := vts.Labels[planetscalev2.ClusterLabel]
labels := map[string]string{
planetscalev2.ComponentLabel: planetscalev2.VttabletComponentName,
planetscalev2.ClusterLabel: vts.Labels[planetscalev2.ClusterLabel],
planetscalev2.KeyspaceLabel: vts.Labels[planetscalev2.KeyspaceLabel],
planetscalev2.ShardLabel: vts.Spec.KeyRange.SafeName(),
}
// Remember which cells we deploy any tablets in.
deployedCells := map[string]struct{}{}
defer func() {
// Sort the list of cells so the order is consistent.
vts.Status.Cells = make([]string, 0, len(deployedCells))
for cellName := range deployedCells {
vts.Status.Cells = append(vts.Status.Cells, cellName)
}
sort.Strings(vts.Status.Cells)
}()
// Compute the set of all desired tablets based on the config.
tablets := vttabletSpecs(vts, labels)
// Generate podKeys (object names) for all desired tablet pods and pvcKeys for desired PVCs.
//
// Keep a map back from generated names to the tablet specs.
pvcKeys := make([]client.ObjectKey, 0, len(tablets))
podKeys := make([]client.ObjectKey, 0, len(tablets))
tabletMap := make(map[client.ObjectKey]*vttablet.Spec, len(tablets))
for _, tablet := range tablets {
podName := vttablet.PodName(clusterName, tablet.Alias)
key := client.ObjectKey{Namespace: vts.Namespace, Name: podName}
if tablet.DataVolumePVCSpec != nil {
// We use the same name for the Pod and the main data volume PVC.
tablet.DataVolumePVCName = podName
pvcKeys = append(pvcKeys, key)
}
podKeys = append(podKeys, key)
tabletMap[key] = tablet
deployedCells[tablet.Alias.Cell] = struct{}{}
// Initialize a status entry for every desired tablet, so it will be
// listed even if we end up not having anything to report about it.
vts.Status.Tablets[tablet.AliasStr] = planetscalev2.NewVitessTabletStatus(tablet.Type, tablet.Index)
}
// Reconcile vttablet PVCs. Note that we use the same keys as the corresponding Pods.
err := r.reconciler.ReconcileObjectSet(ctx, vts, pvcKeys, labels, reconciler.Strategy{
Kind: &corev1.PersistentVolumeClaim{},
New: func(key client.ObjectKey) runtime.Object {
tablet := tabletMap[key]
// The PVC doesn't exist, so it can't be bound.
status := vts.Status.Tablets[tablet.AliasStr]
status.DataVolumeBound = corev1.ConditionFalse
vts.Status.Tablets[tablet.AliasStr] = status
return vttablet.NewPVC(key, tablet)
},
UpdateInPlace: func(key client.ObjectKey, obj runtime.Object) {
curObj := obj.(*corev1.PersistentVolumeClaim)
vttablet.UpdatePVCInPlace(curObj, tabletMap[key])
},
Status: func(key client.ObjectKey, obj runtime.Object) {
tablet := tabletMap[key]
curObj := obj.(*corev1.PersistentVolumeClaim)
status := vts.Status.Tablets[tablet.AliasStr]
status.DataVolumeBound = k8s.ConditionStatus(curObj.Status.Phase == corev1.ClaimBound)
vts.Status.Tablets[tablet.AliasStr] = status
},
PrepareForTurndown: func(key client.ObjectKey, obj runtime.Object) *planetscalev2.OrphanStatus {
// Make sure it's ok to delete this PVC. We gate this on whether the
// corresponding Pod still exists. That way if we decide to keep a
// Pod around (see the other PrepareForTurndown below), we won't try
// to delete the PVC out from under it.
pod := &corev1.Pod{}
if getErr := r.client.Get(ctx, key, pod); getErr == nil || !apierrors.IsNotFound(getErr) {
// If the get was successful, the Pod exists and we shouldn't delete the PVC.
// If the get failed for any reason other than NotFound, we don't know if it's safe.
return planetscalev2.NewOrphanStatus("PodExists", "not deleting tablet PVC because tablet Pod still exists")
}
return nil
},
})
if err != nil {
resultBuilder.Error(err)
}
// Reconcile vttablet Pods.
err = r.reconciler.ReconcileObjectSet(ctx, vts, podKeys, labels, reconciler.Strategy{
Kind: &corev1.Pod{},
New: func(key client.ObjectKey) runtime.Object {
tablet := tabletMap[key]
// The Pod doesn't exist, so it can't be running or ready.
tabletStatus := vts.Status.Tablets[tablet.AliasStr]
tabletStatus.Running = corev1.ConditionFalse
tabletStatus.Ready = corev1.ConditionFalse
tabletStatus.Available = corev1.ConditionFalse
vts.Status.Tablets[tablet.AliasStr] = tabletStatus
return vttablet.NewPod(key, tablet)
},
UpdateInPlace: func(key client.ObjectKey, obj runtime.Object) {
newObj := obj.(*corev1.Pod)
tablet := tabletMap[key]
vttablet.UpdatePodInPlace(newObj, tablet)
if newObj.Annotations == nil {
newObj.Annotations = make(map[string]string)
}
newObj.Annotations[observedShardGenerationAnnotationKey] = strconv.FormatInt(vts.Generation, 10)
},
UpdateRollingRecreate: func(key client.ObjectKey, obj runtime.Object) {
newObj := obj.(*corev1.Pod)
tablet := tabletMap[key]
r.updatePVCFilesystemResizeAnnotation(ctx, tablet, newObj)
vttablet.UpdatePod(newObj, tablet)
},
Status: func(key client.ObjectKey, obj runtime.Object) {
pod := obj.(*corev1.Pod)
tablet := tabletMap[key]
tabletStatus := vts.Status.Tablets[tablet.AliasStr]
tabletStatus.Running = k8s.ConditionStatus(pod.Status.Phase == corev1.PodRunning)
if _, cond := podutil.GetPodCondition(&pod.Status, corev1.PodReady); cond != nil {
tabletStatus.Ready = cond.Status
tabletStatus.Available = tabletAvailableStatus(resultBuilder, pod, cond)
}
tabletStatus.PendingChanges = pod.Annotations[rollout.ScheduledAnnotation]
vts.Status.Tablets[tablet.AliasStr] = tabletStatus
observedShardGenerationVal := pod.Annotations[observedShardGenerationAnnotationKey]
if observedShardGenerationVal == "" {
return
}
observedShardGeneration, err := strconv.ParseInt(observedShardGenerationVal, 10, 64)
if err != nil {
return
}
if vts.Status.LowestPodGeneration == 0 || observedShardGeneration < vts.Status.LowestPodGeneration {
vts.Status.LowestPodGeneration = observedShardGeneration
}
},
OrphanStatus: func(key client.ObjectKey, obj runtime.Object, orphanStatus *planetscalev2.OrphanStatus) {
curObj := obj.(*corev1.Pod)
tabletAlias := vttablet.AliasFromPod(curObj)
tabletAliasStr := topoproto.TabletAliasString(&tabletAlias)
vts.Status.OrphanedTablets[tabletAliasStr] = *orphanStatus
// Since we're keeping this tablet, remember that we're still in that cell.
deployedCells[tabletAlias.Cell] = struct{}{}
},
PrepareForTurndown: func(key client.ObjectKey, obj runtime.Object) *planetscalev2.OrphanStatus {
// Don't hold our slot in the reconcile work queue for too long.
ctx, cancel := context.WithTimeout(ctx, topoReconcileTimeout)
defer cancel()
curObj := obj.(*corev1.Pod)
tabletAlias := vttablet.AliasFromPod(curObj)
// Drain before turn-down.
if !drain.Finished(curObj) {
drain.Start(curObj, "turning down unwanted tablet")
return planetscalev2.NewOrphanStatus("Draining", "waiting for the tablet to be drained before turn-down")
}
// Make sure the tablet is not the master.
isMaster, err := isTabletMaster(ctx, vts, tabletAlias)
if err != nil {
return planetscalev2.NewOrphanStatus("MasterUnknown", "unable to determine whether this tablet is the master")
}
if isMaster {
return planetscalev2.NewOrphanStatus("Master", "this tablet is the master")
}
// Make sure the desired tablets are healthy before removing one.
// We don't want to risk causing more disruption if the shard isn't
// at full strength. The reconciler will have already processed all
// desired tablets before it starts trying to delete undesired tablets,
// so we can assume Status is up to date for all desired tablets.
for _, tablet := range vts.Status.Tablets {
if tablet.Ready != corev1.ConditionTrue {
return planetscalev2.NewOrphanStatus("ShardNotHealthy", "the remaining, desired tablets in the shard are not all healthy")
}
}
return nil
},
})
if err != nil {
resultBuilder.Error(err)
}
return resultBuilder.Result()
}
// vttabletSpecs creates a list of vttablet Specs for a VitessShard.
func vttabletSpecs(vts *planetscalev2.VitessShard, parentLabels map[string]string) []*vttablet.Spec {
keyspaceName := vts.Labels[planetscalev2.KeyspaceLabel]
var tablets []*vttablet.Spec
for poolIndex := range vts.Spec.TabletPools {
pool := &vts.Spec.TabletPools[poolIndex]
// Find the backup location for this pool.
backupLocation := vts.Spec.BackupLocation(pool.BackupLocationName)
// Within each pool, tablets are assigned a 1-based index.
for tabletIndex := int32(1); tabletIndex <= pool.Replicas; tabletIndex++ {
tabletAlias := topodatapb.TabletAlias{
Cell: pool.Cell,
Uid: vttablet.UID(pool.Cell, keyspaceName, vts.Spec.KeyRange, pool.Type, uint32(tabletIndex)),
}
// Copy parent labels map and add tablet-specific labels.
labels := make(map[string]string, len(parentLabels)+4)
for k, v := range parentLabels {
labels[k] = v
}
labels[planetscalev2.CellLabel] = tabletAlias.Cell
labels[planetscalev2.TabletUidLabel] = strconv.FormatUint(uint64(tabletAlias.Uid), 10)
labels[planetscalev2.TabletTypeLabel] = string(pool.Type)
labels[planetscalev2.TabletIndexLabel] = strconv.FormatUint(uint64(tabletIndex), 10)
// Merge ExtraVitessFlags into the tablet spec ExtraFlags field.
extraFlags := make(map[string]string)
update.StringMap(&extraFlags, vts.Spec.ExtraVitessFlags)
update.StringMap(&extraFlags, pool.Vttablet.ExtraFlags)
// Make shallow copy of pool.Vttablet to avoid mutating input.
vttabletcpy := pool.Vttablet
vttabletcpy.ExtraFlags = extraFlags
annotations := map[string]string{
drain.SupportedAnnotation: "ensure that the tablet is not a master",
}
update.Annotations(&annotations, pool.Annotations)
if backupLocation != nil {
update.Annotations(&annotations, backupLocation.Annotations)
}
tablets = append(tablets, &vttablet.Spec{
GlobalLockserver: vts.Spec.GlobalLockserver,
Labels: labels,
Images: vts.Spec.Images,
ImagePullPolicies: vts.Spec.ImagePullPolicies,
ImagePullSecrets: vts.Spec.ImagePullSecrets,
Index: tabletIndex,
KeyRange: vts.Spec.KeyRange,
Alias: tabletAlias,
AliasStr: topoproto.TabletAliasString(&tabletAlias),
Zone: vts.Spec.ZoneMap[tabletAlias.Cell],
Vttablet: &vttabletcpy,
Mysqld: pool.Mysqld,
ExternalDatastore: pool.ExternalDatastore,
Type: pool.Type,
DataVolumePVCSpec: pool.DataVolumeClaimTemplate,
KeyspaceName: keyspaceName,
DatabaseName: vts.Spec.DatabaseName,
DatabaseInitScriptSecret: vts.Spec.DatabaseInitScriptSecret,
EnableSemiSync: vts.Spec.Replication.EnforceSemiSync,
Annotations: annotations,
BackupLocation: backupLocation,
BackupEngine: vts.Spec.BackupEngine,
Affinity: pool.Affinity,
ExtraEnv: pool.ExtraEnv,
ExtraVolumes: pool.ExtraVolumes,
ExtraLabels: pool.ExtraLabels,
InitContainers: pool.InitContainers,
SidecarContainers: pool.SidecarContainers,
ExtraVolumeMounts: pool.ExtraVolumeMounts,
Tolerations: pool.Tolerations,
TopologySpreadConstraints: pool.TopologySpreadConstraints,
})
}
}
return tablets
}
func isTabletMaster(ctx context.Context, vts *planetscalev2.VitessShard, tabletAlias topodatapb.TabletAlias) (bool, error) {
ts, err := toposerver.Open(ctx, vts.Spec.GlobalLockserver)
if err != nil {
return true, err
}
defer ts.Close()
// Only check the global shard record for the master alias.
// We don't check the individual tablet's record (what the tablet thinks it is)
// because it's important to allow deletion of false masters.
keyspaceName := vts.Labels[planetscalev2.KeyspaceLabel]
shard, err := ts.GetShard(ctx, keyspaceName, vts.Spec.Name)
if err != nil {
return true, err
}
return topoproto.TabletAliasEqual(shard.MasterAlias, &tabletAlias), nil
}
func tabletAvailableStatus(resultBuilder *results.Builder, pod *corev1.Pod, readyCond *corev1.PodCondition) corev1.ConditionStatus {
// If the Pod is being deleted, we immediately mark it unavailable even
// though it might not have transitioned to Unready yet.
if pod.DeletionTimestamp != nil {
return corev1.ConditionFalse
}
// If it's not Ready, it can't be Available.
if readyCond.Status != corev1.ConditionTrue {
return corev1.ConditionFalse
}
// A tablet is Available if it's been consistently Ready for long enough.
// Note that this is sensitive to clock skew between us and the k8s master,
// but it's the same trade-off that k8s controllers make to determine Pod
// availability.
readyDuration := time.Since(readyCond.LastTransitionTime.Time)
if readyDuration >= tabletAvailableTime {
return corev1.ConditionTrue
}
// The Pod is Ready now, but it hasn't been Ready for long enough to
// consider it Available. We need to request a manual requeue to check again
// later because we're just waiting for time to pass; we don't expect
// anything in the Pod status to change and trigger a watch event.
resultBuilder.RequeueAfter(tabletAvailableTime - readyDuration)
return corev1.ConditionFalse
}
func (r *ReconcileVitessShard) updatePVCFilesystemResizeAnnotation(ctx context.Context, tabletSpec *vttablet.Spec, pod *corev1.Pod) {
// If no PVC is configured for this tablet pod, bail out.
if tabletSpec.DataVolumePVCSpec == nil {
return
}
pvc := &corev1.PersistentVolumeClaim{}
pvcKey := client.ObjectKey{
Namespace: pod.Namespace,
Name: tabletSpec.DataVolumePVCName,
}
// If a matching PVC doesn't exist for this tablet pod, bail out.
err := r.client.Get(ctx, pvcKey, pvc)
if err != nil {
return
}
// Check that the ResourceStorage entry is there in the tablet spec.
requestedDiskQuantity, ok := tabletSpec.DataVolumePVCSpec.Resources.Requests[corev1.ResourceStorage]
if !ok {
return
}
// If the PVC's spec has not been updated to equal the desired size, bail.
currentDiskQuantity := pvc.Spec.Resources.Requests[corev1.ResourceStorage]
if currentDiskQuantity.Value() != requestedDiskQuantity.Value() {
return
}
// If the matching PVC does not have the FileSystemResizePending condition, bail out.
if !checkPVCFileSystemResizeCondition(pvc) {
return
}
// If all checks pass, set the resize annotation.
tabletSpec.Annotations[pvcFilesystemResizeAnnotation] = requestedDiskQuantity.String()
}
func checkPVCFileSystemResizeCondition(pvc *corev1.PersistentVolumeClaim) bool {
for _, condition := range pvc.Status.Conditions {
if condition.Type != corev1.PersistentVolumeClaimFileSystemResizePending {
continue
}
return condition.Status == corev1.ConditionTrue
}
return false
}