forked from kubermatic/kubermatic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
backup_controller.go
502 lines (447 loc) · 16.2 KB
/
backup_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
491
492
493
494
495
496
497
498
499
500
501
502
/*
Copyright 2020 The Kubermatic Kubernetes Platform contributors.
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 backup
import (
"context"
"fmt"
"strings"
"time"
"github.com/robfig/cron"
"go.uber.org/zap"
kubermaticv1 "github.com/kubermatic/kubermatic/api/pkg/crd/kubermatic/v1"
kubermaticv1helper "github.com/kubermatic/kubermatic/api/pkg/crd/kubermatic/v1/helper"
kuberneteshelper "github.com/kubermatic/kubermatic/api/pkg/kubernetes"
"github.com/kubermatic/kubermatic/api/pkg/resources"
"github.com/kubermatic/kubermatic/api/pkg/resources/certificates"
"github.com/kubermatic/kubermatic/api/pkg/resources/certificates/triple"
"github.com/kubermatic/kubermatic/api/pkg/resources/etcd"
"github.com/kubermatic/kubermatic/api/pkg/resources/reconciling"
batchv1 "k8s.io/api/batch/v1"
batchv1beta1 "k8s.io/api/batch/v1beta1"
corev1 "k8s.io/api/core/v1"
kerrors "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"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/tools/record"
utilpointer "k8s.io/utils/pointer"
ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const (
// SharedVolumeName is the name of the `emptyDir` volume the initContainer
// will write the backup to
SharedVolumeName = "etcd-backup"
// DefaultBackupContainerImage holds the default Image used for creating the etcd backups
DefaultBackupContainerImage = "gcr.io/etcd-development/etcd"
// DefaultBackupInterval defines the default interval used to create backups
DefaultBackupInterval = "20m"
// cronJobPrefix defines the prefix used for all backup cronjob names
cronJobPrefix = "etcd-backup"
// cleanupFinalizer defines the name for the finalizer to ensure we cleanup after we deleted a cluster
cleanupFinalizer = "kubermatic.io/cleanup-backups"
// backupCleanupJobLabel defines the label we use on all cleanup jobs
backupCleanupJobLabel = "kubermatic-etcd-backup-cleaner"
// clusterEnvVarKey defines the environment variable key for the cluster name
clusterEnvVarKey = "CLUSTER"
ControllerName = "kubermatic_backup_controller"
)
type Reconciler struct {
log *zap.SugaredLogger
workerName string
storeContainer corev1.Container
cleanupContainer corev1.Container
// backupScheduleString is the cron string representing
// the backupSchedule
backupScheduleString string
// backupContainerImage holds the image used for creating the etcd backup
// It must be configurable to cover offline use cases
backupContainerImage string
ctrlruntimeclient.Client
recorder record.EventRecorder
}
// Add creates a new Backup controller that is responsible for creating backupjobs
// for all managed user clusters
func Add(
log *zap.SugaredLogger,
mgr manager.Manager,
numWorkers int,
workerName string,
storeContainer corev1.Container,
cleanupContainer corev1.Container,
backupSchedule time.Duration,
backupContainerImage string,
) error {
log = log.Named(ControllerName)
if err := validateStoreContainer(storeContainer); err != nil {
return err
}
backupScheduleString, err := parseDuration(backupSchedule)
if err != nil {
return fmt.Errorf("failed to parse backup duration: %v", err)
}
if backupContainerImage == "" {
backupContainerImage = DefaultBackupContainerImage
}
reconciler := &Reconciler{
log: log,
workerName: workerName,
storeContainer: storeContainer,
cleanupContainer: cleanupContainer,
backupScheduleString: backupScheduleString,
backupContainerImage: backupContainerImage,
Client: mgr.GetClient(),
recorder: mgr.GetEventRecorderFor(ControllerName),
}
c, err := controller.New(ControllerName, mgr, controller.Options{
Reconciler: reconciler,
MaxConcurrentReconciles: numWorkers,
})
if err != nil {
return fmt.Errorf("failed to create controller: %v", err)
}
cronJobMapFn := &handler.EnqueueRequestsFromMapFunc{ToRequests: handler.ToRequestsFunc(func(a handler.MapObject) []reconcile.Request {
// We only care about CronJobs that are in the kube-system namespace
if a.Meta.GetNamespace() != metav1.NamespaceSystem {
return nil
}
if ownerRef := metav1.GetControllerOf(a.Meta); ownerRef != nil && ownerRef.Kind == kubermaticv1.ClusterKindName {
return []reconcile.Request{{NamespacedName: types.NamespacedName{Name: ownerRef.Name}}}
}
return nil
})}
if err := c.Watch(&source.Kind{Type: &kubermaticv1.Cluster{}}, &handler.EnqueueRequestForObject{}); err != nil {
return fmt.Errorf("failed to watch Clusters: %v", err)
}
if err := c.Watch(&source.Kind{Type: &batchv1beta1.CronJob{}}, cronJobMapFn); err != nil {
return fmt.Errorf("failed to watch CronJobs: %v", err)
}
// Cleanup cleanup jobs...
if err := mgr.Add(&runnableWrapper{
f: func(stopCh <-chan struct{}) {
wait.Until(reconciler.cleanupJobs, 30*time.Second, stopCh)
},
}); err != nil {
return fmt.Errorf("failed to add cleanup jobs runnable to mgr: %v", err)
}
return nil
}
type runnableWrapper struct {
f func(<-chan struct{})
}
func (w *runnableWrapper) Start(stopChan <-chan struct{}) error {
w.f(stopChan)
return nil
}
func (r *Reconciler) cleanupJobs() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
log := r.log.Named("job_cleanup")
selector, err := labels.Parse(fmt.Sprintf("%s=%s", resources.AppLabelKey, backupCleanupJobLabel))
if err != nil {
utilruntime.HandleError(err)
return
}
jobs := &batchv1.JobList{}
if err := r.List(ctx, jobs, &ctrlruntimeclient.ListOptions{LabelSelector: selector}); err != nil {
log.Errorw("failed to list jobs", "selector", selector.String(), zap.Error(err))
utilruntime.HandleError(fmt.Errorf("failed to list jobs: %v", err))
return
}
for _, job := range jobs.Items {
if job.Status.Succeeded >= 1 && (job.Status.CompletionTime != nil && time.Since(job.Status.CompletionTime.Time).Minutes() > 5) {
deletePropagationForeground := metav1.DeletePropagationForeground
delOpts := &ctrlruntimeclient.DeleteOptions{
PropagationPolicy: &deletePropagationForeground,
}
jobName := types.NamespacedName{Name: job.Name, Namespace: job.Namespace}
if err := r.Delete(ctx, &job, delOpts); err != nil {
log.Errorw(
"Failed to delete cleanup job",
zap.Error(err),
"job_name", jobName,
)
utilruntime.HandleError(err)
return
}
log.Infow("Deleted the cleanup job", "job_name", jobName)
}
}
}
func (r *Reconciler) Reconcile(request reconcile.Request) (reconcile.Result, error) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
log := r.log.With("request", request)
log.Debug("Processing")
cluster := &kubermaticv1.Cluster{}
if err := r.Get(ctx, types.NamespacedName{Name: request.Name}, cluster); err != nil {
if kerrors.IsNotFound(err) {
return reconcile.Result{}, nil
}
return reconcile.Result{}, err
}
// Add a wrapping here so we can emit an event on error
_, err := kubermaticv1helper.ClusterReconcileWrapper(
ctx,
r.Client,
r.workerName,
cluster,
kubermaticv1.ClusterConditionBackupControllerReconcilingSuccess,
func() (*reconcile.Result, error) {
return nil, r.reconcile(ctx, log, cluster)
},
)
if err != nil {
log.Errorw("Reconciling failed", zap.Error(err))
r.recorder.Eventf(cluster, corev1.EventTypeWarning, "ReconcilingError", "%v", err)
}
return reconcile.Result{}, err
}
func (r *Reconciler) reconcile(ctx context.Context, log *zap.SugaredLogger, cluster *kubermaticv1.Cluster) error {
// Cluster got deleted - regardless if the cluster was ever running, we cleanup
if cluster.DeletionTimestamp != nil {
// Need to cleanup
if sets.NewString(cluster.Finalizers...).Has(cleanupFinalizer) {
if err := r.Create(ctx, r.cleanupJob(cluster)); err != nil {
// Otherwise we end up in a loop when we are able to create the job but not
// remove the finalizer.
if !kerrors.IsAlreadyExists(err) {
return err
}
}
oldCluster := cluster.DeepCopy()
kuberneteshelper.RemoveFinalizer(cluster, cleanupFinalizer)
if err := r.Patch(ctx, cluster, ctrlruntimeclient.MergeFrom(oldCluster)); err != nil {
return fmt.Errorf("failed to update cluster after removing cleanup finalizer: %v", err)
}
}
return nil
}
if cluster.Status.ExtendedHealth.Etcd != kubermaticv1.HealthStatusUp {
log.Debug("Skipping because the cluster has no running etcd yet")
return nil
}
// Always add the finalizer first
if !kuberneteshelper.HasFinalizer(cluster, cleanupFinalizer) {
oldCluster := cluster.DeepCopy()
kuberneteshelper.AddFinalizer(cluster, cleanupFinalizer)
if err := r.Patch(ctx, cluster, ctrlruntimeclient.MergeFrom(oldCluster)); err != nil {
return fmt.Errorf("failed to update cluster after adding cleanup finalizer: %v", err)
}
}
if err := r.ensureCronJobSecret(ctx, cluster); err != nil {
return fmt.Errorf("failed to create backup secret: %v", err)
}
return reconciling.ReconcileCronJobs(ctx, []reconciling.NamedCronJobCreatorGetter{r.cronjob(cluster)}, metav1.NamespaceSystem, r.Client)
}
func (r *Reconciler) getEtcdSecretName(cluster *kubermaticv1.Cluster) string {
return fmt.Sprintf("cluster-%s-etcd-client-certificate", cluster.Name)
}
func (r *Reconciler) ensureCronJobSecret(ctx context.Context, cluster *kubermaticv1.Cluster) error {
secretName := r.getEtcdSecretName(cluster)
getCA := func() (*triple.KeyPair, error) {
return resources.GetClusterRootCA(ctx, cluster.Status.NamespaceName, r.Client)
}
_, creator := certificates.GetClientCertificateCreator(
secretName,
"backup",
nil,
resources.BackupEtcdClientCertificateCertSecretKey,
resources.BackupEtcdClientCertificateKeySecretKey,
getCA,
)()
wrappedCreator := reconciling.SecretObjectWrapper(creator)
wrappedCreator = reconciling.OwnerRefWrapper(resources.GetClusterRef(cluster))(wrappedCreator)
err := reconciling.EnsureNamedObject(
ctx,
types.NamespacedName{Namespace: metav1.NamespaceSystem, Name: secretName},
wrappedCreator, r.Client, &corev1.Secret{}, false)
if err != nil {
return fmt.Errorf("failed to ensure Secret %q: %v", secretName, err)
}
return nil
}
func (r *Reconciler) cleanupJob(cluster *kubermaticv1.Cluster) *batchv1.Job {
cleanupContainer := r.cleanupContainer.DeepCopy()
cleanupContainer.Env = append(cleanupContainer.Env, corev1.EnvVar{
Name: clusterEnvVarKey,
Value: cluster.Name,
})
return &batchv1.Job{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("remove-cluster-backups-%s", cluster.Name),
Namespace: metav1.NamespaceSystem,
Labels: map[string]string{
resources.AppLabelKey: backupCleanupJobLabel,
},
},
Spec: batchv1.JobSpec{
BackoffLimit: utilpointer.Int32Ptr(10),
Completions: utilpointer.Int32Ptr(1),
Parallelism: utilpointer.Int32Ptr(1),
ActiveDeadlineSeconds: resources.Int64(30 * 60 * 60),
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
Containers: []corev1.Container{
*cleanupContainer,
},
RestartPolicy: corev1.RestartPolicyNever,
Volumes: []corev1.Volume{
{
Name: SharedVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
},
},
},
},
},
}
}
func (r *Reconciler) cronjob(cluster *kubermaticv1.Cluster) reconciling.NamedCronJobCreatorGetter {
return func() (string, reconciling.CronJobCreator) {
return fmt.Sprintf("%s-%s", cronJobPrefix, cluster.Name), func(cronJob *batchv1beta1.CronJob) (*batchv1beta1.CronJob, error) {
gv := kubermaticv1.SchemeGroupVersion
cronJob.OwnerReferences = []metav1.OwnerReference{
*metav1.NewControllerRef(cluster, gv.WithKind(kubermaticv1.ClusterKindName)),
}
// Spec
cronJob.Spec.Schedule = r.backupScheduleString
cronJob.Spec.ConcurrencyPolicy = batchv1beta1.ForbidConcurrent
cronJob.Spec.Suspend = utilpointer.BoolPtr(false)
cronJob.Spec.SuccessfulJobsHistoryLimit = utilpointer.Int32Ptr(0)
endpoints := etcd.GetClientEndpoints(cluster.Status.NamespaceName)
image := r.backupContainerImage
if !strings.Contains(image, ":") {
image = image + ":" + etcd.ImageTag(cluster)
}
cronJob.Spec.JobTemplate.Spec.Template.Spec.InitContainers = []corev1.Container{
{
Name: "backup-creator",
Image: image,
Env: []corev1.EnvVar{
{
Name: "ETCDCTL_API",
Value: "3",
},
{
Name: "ETCDCTL_DIAL_TIMEOUT",
Value: "3s",
},
{
Name: "ETCDCTL_CACERT",
Value: "/etc/etcd/client/ca.crt",
},
{
Name: "ETCDCTL_CERT",
Value: "/etc/etcd/client/backup-etcd-client.crt",
},
{
Name: "ETCDCTL_KEY",
Value: "/etc/etcd/client/backup-etcd-client.key",
},
},
Command: snapshotCommand(endpoints),
VolumeMounts: []corev1.VolumeMount{
{
Name: SharedVolumeName,
MountPath: "/backup",
},
{
Name: r.getEtcdSecretName(cluster),
MountPath: "/etc/etcd/client",
},
},
},
}
storeContainer := r.storeContainer.DeepCopy()
storeContainer.Env = append(storeContainer.Env, corev1.EnvVar{
Name: clusterEnvVarKey,
Value: cluster.Name,
})
cronJob.Spec.JobTemplate.Spec.Template.Spec.RestartPolicy = corev1.RestartPolicyOnFailure
cronJob.Spec.JobTemplate.Spec.Template.Spec.Containers = []corev1.Container{*storeContainer}
cronJob.Spec.JobTemplate.Spec.Template.Spec.Volumes = []corev1.Volume{
{
Name: SharedVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
},
{
Name: r.getEtcdSecretName(cluster),
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: r.getEtcdSecretName(cluster),
},
},
},
}
return cronJob, nil
}
}
}
func parseDuration(interval time.Duration) (string, error) {
scheduleString := fmt.Sprintf("@every %vm", interval.Round(time.Minute).Minutes())
// We verify the validity of the scheduleString here, because the cronjob controller
// only does that inside its sync loop, which means it is entirely possible to create
// a cronJob with an invalid scheduleString
// Refs:
// https://github.com/kubernetes/kubernetes/blob/d02cf08e27f640f09ebd489e094176fd075f3463/pkg/controller/cronjob/cronjob_controller.go#L253
// https://github.com/kubernetes/kubernetes/blob/d02cf08e27f640f09ebd489e094176fd075f3463/pkg/controller/cronjob/utils.go#L98
_, err := cron.ParseStandard(scheduleString)
if err != nil {
return "", err
}
return scheduleString, nil
}
func validateStoreContainer(storeContainer corev1.Container) error {
for _, volumeMount := range storeContainer.VolumeMounts {
if volumeMount.Name == SharedVolumeName {
return nil
}
}
return fmt.Errorf("storeContainer does not have a mount for the shared volume %s", SharedVolumeName)
}
func snapshotCommand(etcdEndpoints []string) []string {
cmd := []string{
"/bin/sh",
"-c",
}
script := &strings.Builder{}
// Accordings to its godoc, this always returns a nil error
_, _ = script.WriteString(
`backupOrReportFailure() {
echo "Creating backup"
if ! eval $@; then
echo "Backup creation failed"
return 1
fi
echo "Successfully created backup, exiting"
exit 0
}`)
for _, endpoint := range etcdEndpoints {
_, _ = script.WriteString(fmt.Sprintf("\nbackupOrReportFailure etcdctl --endpoints %s snapshot save /backup/snapshot.db", endpoint))
}
_, _ = script.WriteString("\necho \"Unable to create backup\"\nexit 1")
cmd = append(cmd, script.String())
return cmd
}