-
Notifications
You must be signed in to change notification settings - Fork 579
/
statefulset_update.go
471 lines (401 loc) · 14 KB
/
statefulset_update.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
// Copyright 2021 Redpanda Data, Inc.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.md
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0
package resources
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/url"
"reflect"
"sort"
"strings"
"time"
"github.com/banzaicloud/k8s-objectmatcher/patch"
"github.com/redpanda-data/redpanda/src/go/k8s/pkg/labels"
"github.com/redpanda-data/redpanda/src/go/k8s/pkg/resources/featuregates"
"github.com/redpanda-data/redpanda/src/go/k8s/pkg/utils"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
k8sclient "sigs.k8s.io/controller-runtime/pkg/client"
)
const (
// RequeueDuration is the time controller should
// requeue resource reconciliation.
RequeueDuration = time.Second * 10
adminAPITimeout = time.Millisecond * 100
)
var errRedpandaNotReady = errors.New("redpanda not ready")
// runUpdate handles image changes and additional storage in the redpanda cluster
// CR by removing statefulset with orphans Pods. The stateful set is then recreated
// and all Pods are restarted accordingly to the ordinal number.
//
// The process maintains an Restarting bool status that is set to true once the
// generated stateful differentiate from the actual state. It is set back to
// false when all pods are verified.
//
// The steps are as follows: 1) check the Restarting status or if the statefulset
// differentiate from the current stored statefulset definition 2) if true,
// set the Restarting status to true and remove statefulset with the orphan Pods
// 3) perform rolling update like removing Pods accordingly to theirs ordinal
// number 4) requeue until the pod is in ready state 5) prior to a pod update
// verify the previously updated pod and requeue as necessary. Currently, the
// verification checks the pod has started listening in its http Admin API port and may be
// extended.
func (r *StatefulSetResource) runUpdate(
ctx context.Context, current, modified *appsv1.StatefulSet,
) error {
// Keep existing central config hash annotation during standard reconciliation
if ann, ok := current.Spec.Template.Annotations[CentralizedConfigurationHashAnnotationKey]; ok {
if modified.Spec.Template.Annotations == nil {
modified.Spec.Template.Annotations = make(map[string]string)
}
modified.Spec.Template.Annotations[CentralizedConfigurationHashAnnotationKey] = ann
}
update, err := r.shouldUpdate(r.pandaCluster.Status.IsRestarting(), current, modified)
if err != nil {
return fmt.Errorf("unable to determine the update procedure: %w", err)
}
if !update {
return nil
}
if err = r.updateRestartingStatus(ctx, true); err != nil {
return fmt.Errorf("unable to turn on restarting status in cluster custom resource: %w", err)
}
if err = r.updateStatefulSet(ctx, current, modified); err != nil {
return err
}
if err = r.isClusterHealthy(ctx); err != nil {
return err
}
if err = r.rollingUpdate(ctx, &modified.Spec.Template); err != nil {
return err
}
// Update is complete for all pods (and all are ready). Set restarting status to false.
if err = r.updateRestartingStatus(ctx, false); err != nil {
return fmt.Errorf("unable to turn off restarting status in cluster custom resource: %w", err)
}
return nil
}
func (r *StatefulSetResource) isClusterHealthy(ctx context.Context) error {
if !featuregates.ClusterHealth(r.pandaCluster.Status.Version) {
r.logger.V(debugLogLevel).Info("Cluster health endpoint is not available", "version", r.pandaCluster.Spec.Version)
return nil
}
adminAPIClient, err := r.getAdminAPIClient(ctx)
if err != nil {
return fmt.Errorf("creating admin API client: %w", err)
}
health, err := adminAPIClient.GetHealthOverview(ctx)
if err != nil {
return fmt.Errorf("getting cluster health overview: %w", err)
}
restarting := "not restarting"
if r.pandaCluster.Status.IsRestarting() {
restarting = "restarting"
}
if !health.IsHealthy {
return &RequeueAfterError{
RequeueAfter: RequeueDuration,
Msg: fmt.Sprintf("wait for cluster to become healthy (cluster %s)", restarting),
}
}
return nil
}
func (r *StatefulSetResource) rollingUpdate(
ctx context.Context, template *corev1.PodTemplateSpec,
) error {
var podList corev1.PodList
err := r.List(ctx, &podList, &k8sclient.ListOptions{
Namespace: r.pandaCluster.Namespace,
LabelSelector: labels.ForCluster(r.pandaCluster).AsClientSelector(),
})
if err != nil {
return fmt.Errorf("unable to list panda pods: %w", err)
}
sort.Slice(podList.Items, func(i, j int) bool {
return podList.Items[i].Name < podList.Items[j].Name
})
var artificialPod corev1.Pod
artificialPod.Annotations = template.Annotations
artificialPod.Spec = template.Spec
volumes := make(map[string]interface{})
for i := range template.Spec.Volumes {
vol := template.Spec.Volumes[i]
volumes[vol.Name] = new(interface{})
}
opts := []patch.CalculateOption{
patch.IgnoreStatusFields(),
ignoreKubernetesTokenVolumeMounts(),
ignoreDefaultToleration(),
ignoreExistingVolumes(volumes),
}
for i := range podList.Items {
pod := podList.Items[i]
patchResult, err := patch.DefaultPatchMaker.Calculate(&pod, &artificialPod, opts...)
if err != nil {
return err
}
if !patchResult.IsEmpty() {
r.logger.Info("Changes in Pod definition other than activeDeadlineSeconds, configurator and Redpanda container name. Deleting pod",
"pod-name", pod.Name,
"patch", patchResult.Patch)
if err = r.Delete(ctx, &pod); err != nil {
return fmt.Errorf("unable to remove Redpanda pod: %w", err)
}
return &RequeueAfterError{RequeueAfter: RequeueDuration, Msg: "wait for pod restart"}
}
if !utils.IsPodReady(&pod) {
return &RequeueAfterError{
RequeueAfter: RequeueDuration,
Msg: fmt.Sprintf("wait for %s pod to become ready", pod.Name),
}
}
headlessServiceWithPort := fmt.Sprintf("%s:%d", r.serviceFQDN,
r.pandaCluster.AdminAPIInternal().Port)
adminURL := url.URL{
Scheme: "http",
Host: fmt.Sprintf("%s.%s", pod.Name, headlessServiceWithPort),
Path: "v1/status/ready",
}
r.logger.Info("Verify that Ready endpoint returns HTTP status OK")
if err = r.queryRedpandaStatus(ctx, &adminURL); err != nil {
return fmt.Errorf("unable to query Redpanda ready status: %w", err)
}
}
return nil
}
func (r *StatefulSetResource) updateStatefulSet(
ctx context.Context,
current *appsv1.StatefulSet,
modified *appsv1.StatefulSet,
) error {
_, err := Update(ctx, current, modified, r.Client, r.logger)
if err != nil && strings.Contains(err.Error(), "spec: Forbidden: updates to statefulset spec for fields other than") {
// REF: https://github.com/kubernetes/kubernetes/issues/69041#issuecomment-723757166
// https://www.giffgaff.io/tech/resizing-statefulset-persistent-volumes-with-zero-downtime
// in-place rolling update of a pod - https://github.com/kubernetes/kubernetes/issues/9043
orphan := metav1.DeletePropagationOrphan
err = r.Client.Delete(ctx, current, &k8sclient.DeleteOptions{
PropagationPolicy: &orphan,
})
if err != nil {
return fmt.Errorf("unable to delete statefulset using orphan propagation policy: %w", err)
}
return &RequeueAfterError{RequeueAfter: RequeueDuration, Msg: "wait for sts to be deleted"}
}
if err != nil {
return fmt.Errorf("unable to update statefulset: %w", err)
}
return nil
}
// shouldUpdate returns true if changes on the CR require update
func (r *StatefulSetResource) shouldUpdate(
isRestarting bool, current, modified *appsv1.StatefulSet,
) (bool, error) {
prepareResourceForPatch(current, modified)
opts := []patch.CalculateOption{
patch.IgnoreStatusFields(),
patch.IgnoreVolumeClaimTemplateTypeMetaAndStatus(),
utils.IgnoreAnnotation(patch.LastAppliedConfig),
utils.IgnoreAnnotation(CentralizedConfigurationHashAnnotationKey),
}
patchResult, err := patch.DefaultPatchMaker.Calculate(current, modified, opts...)
if err != nil {
return false, err
}
return !patchResult.IsEmpty() || isRestarting, nil
}
func (r *StatefulSetResource) updateRestartingStatus(
ctx context.Context, restarting bool,
) error {
if !reflect.DeepEqual(restarting, r.pandaCluster.Status.IsRestarting()) {
r.pandaCluster.Status.SetRestarting(restarting)
r.logger.Info("Status updated",
"restarting", restarting,
"resource name", r.pandaCluster.Name)
if err := r.Status().Update(ctx, r.pandaCluster); err != nil {
return err
}
}
return nil
}
func ignoreExistingVolumes(
volumes map[string]interface{},
) patch.CalculateOption {
return func(current, modified []byte) ([]byte, []byte, error) {
current, err := deleteExistingVolumes(current, volumes)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from current byte sequence: %w", err)
}
modified, err = deleteExistingVolumes(modified, volumes)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from modified byte sequence: %w", err)
}
return current, modified, nil
}
}
func deleteExistingVolumes(
obj []byte, volumes map[string]interface{},
) ([]byte, error) {
var pod corev1.Pod
err := json.Unmarshal(obj, &pod)
if err != nil {
return nil, fmt.Errorf("could not unmarshal byte sequence: %w", err)
}
var newVolumes []corev1.Volume
for i := range pod.Spec.Volumes {
_, ok := volumes[pod.Spec.Volumes[i].Name]
if !ok {
newVolumes = append(newVolumes, pod.Spec.Volumes[i])
}
}
pod.Spec.Volumes = newVolumes
obj, err = json.Marshal(pod)
if err != nil {
return nil, fmt.Errorf("could not marshal byte sequence: %w", err)
}
return obj, nil
}
func ignoreDefaultToleration() patch.CalculateOption {
return func(current, modified []byte) ([]byte, []byte, error) {
current, err := deleteDefaultToleration(current)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from current byte sequence: %w", err)
}
modified, err = deleteDefaultToleration(modified)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from modified byte sequence: %w", err)
}
return current, modified, nil
}
}
func deleteDefaultToleration(obj []byte) ([]byte, error) {
var pod corev1.Pod
err := json.Unmarshal(obj, &pod)
if err != nil {
return nil, fmt.Errorf("could not unmarshal byte sequence: %w", err)
}
var newToleration []corev1.Toleration
tolerations := pod.Spec.Tolerations
for i := range tolerations {
switch tolerations[i].Key {
case "node.kubernetes.io/not-ready":
case "node.kubernetes.io/unreachable":
continue
default:
newToleration = append(newToleration, tolerations[i])
}
}
pod.Spec.Tolerations = newToleration
obj, err = json.Marshal(pod)
if err != nil {
return nil, fmt.Errorf("could not marshal byte sequence: %w", err)
}
return obj, nil
}
func ignoreKubernetesTokenVolumeMounts() patch.CalculateOption {
return func(current, modified []byte) ([]byte, []byte, error) {
current, err := deleteKubernetesTokenVolumeMounts(current)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from current byte sequence: %w", err)
}
modified, err = deleteKubernetesTokenVolumeMounts(modified)
if err != nil {
return []byte{}, []byte{}, fmt.Errorf("could not delete configurator init container field from modified byte sequence: %w", err)
}
return current, modified, nil
}
}
func deleteKubernetesTokenVolumeMounts(obj []byte) ([]byte, error) {
var pod corev1.Pod
err := json.Unmarshal(obj, &pod)
if err != nil {
return nil, fmt.Errorf("could not unmarshal byte sequence: %w", err)
}
tokenVolumeName := fmt.Sprintf("%s-token-", pod.Name)
containers := pod.Spec.Containers
for i := range containers {
c := containers[i]
for j := range c.VolumeMounts {
vol := c.VolumeMounts[j]
if strings.HasPrefix(vol.Name, tokenVolumeName) {
c.VolumeMounts = append(c.VolumeMounts[:j], c.VolumeMounts[j+1:]...)
}
}
}
initContainers := pod.Spec.InitContainers
for i := range initContainers {
ic := initContainers[i]
for j := range ic.VolumeMounts {
vol := ic.VolumeMounts[j]
if strings.HasPrefix(vol.Name, tokenVolumeName) {
ic.VolumeMounts = append(ic.VolumeMounts[:j], ic.VolumeMounts[j+1:]...)
}
}
}
obj, err = json.Marshal(pod)
if err != nil {
return nil, fmt.Errorf("could not marshal byte sequence: %w", err)
}
return obj, nil
}
// Temporarily using the status/ready endpoint until we have a specific one for restarting.
func (r *StatefulSetResource) queryRedpandaStatus(
ctx context.Context, adminURL *url.URL,
) error {
client := &http.Client{Timeout: adminAPITimeout}
// TODO right now we support TLS only on one listener so if external
// connectivity is enabled, TLS is enabled only on external listener. This
// will be fixed by https://github.com/redpanda-data/redpanda/issues/1084
if r.pandaCluster.AdminAPITLS() != nil &&
r.pandaCluster.AdminAPIExternal() == nil {
tlsConfig, err := r.adminTLSConfigProvider.GetTLSConfig(ctx, r)
if err != nil {
return err
}
client.Transport = &http.Transport{
TLSClientConfig: tlsConfig,
}
adminURL.Scheme = "https"
}
req, err := http.NewRequestWithContext(ctx, http.MethodGet, adminURL.String(), http.NoBody)
if err != nil {
return err
}
resp, err := client.Do(req)
if err != nil {
return err
}
resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return errRedpandaNotReady
}
return nil
}
// RequeueAfterError error carrying the time after which to requeue.
type RequeueAfterError struct {
RequeueAfter time.Duration
Msg string
}
func (e *RequeueAfterError) Error() string {
return fmt.Sprintf("RequeueAfterError %s", e.Msg)
}
func (e *RequeueAfterError) Is(target error) bool {
return e.Error() == target.Error()
}
// RequeueError error to requeue using default retry backoff.
type RequeueError struct {
Msg string
}
func (e *RequeueError) Error() string {
return fmt.Sprintf("RequeueError %s", e.Msg)
}