forked from rancher/rancher
-
Notifications
You must be signed in to change notification settings - Fork 0
/
etcdbackup.go
459 lines (413 loc) · 14.4 KB
/
etcdbackup.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
package etcdbackup
import (
"context"
"crypto/tls"
"crypto/x509"
"fmt"
"net/http"
"strings"
"time"
minio "github.com/minio/minio-go"
"github.com/minio/minio-go/pkg/credentials"
"github.com/rancher/kontainer-engine/drivers/rke"
"github.com/rancher/kontainer-engine/service"
"github.com/rancher/rancher/pkg/controllers/management/clusterprovisioner"
"github.com/rancher/rancher/pkg/rkedialerfactory"
"github.com/rancher/rancher/pkg/ticker"
v1 "github.com/rancher/types/apis/core/v1"
v3 "github.com/rancher/types/apis/management.cattle.io/v3"
"github.com/rancher/types/config"
"github.com/sirupsen/logrus"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/wait"
)
const (
clusterBackupCheckInterval = 5 * time.Minute
s3Endpoint = "s3.amazonaws.com"
)
type Controller struct {
ctx context.Context
clusterClient v3.ClusterInterface
clusterLister v3.ClusterLister
backupClient v3.EtcdBackupInterface
backupLister v3.EtcdBackupLister
backupDriver *service.EngineService
secretsClient v1.SecretInterface
KontainerDriverLister v3.KontainerDriverLister
}
func Register(ctx context.Context, management *config.ManagementContext) {
c := &Controller{
ctx: ctx,
clusterClient: management.Management.Clusters(""),
clusterLister: management.Management.Clusters("").Controller().Lister(),
backupClient: management.Management.EtcdBackups(""),
backupLister: management.Management.EtcdBackups("").Controller().Lister(),
backupDriver: service.NewEngineService(clusterprovisioner.NewPersistentStore(management.Core.Namespaces(""), management.Core)),
secretsClient: management.Core.Secrets(""),
KontainerDriverLister: management.Management.KontainerDrivers("").Controller().Lister(),
}
local := &rkedialerfactory.RKEDialerFactory{
Factory: management.Dialer,
}
docker := &rkedialerfactory.RKEDialerFactory{
Factory: management.Dialer,
Docker: true,
}
driver := service.Drivers[service.RancherKubernetesEngineDriverName]
rkeDriver := driver.(*rke.Driver)
rkeDriver.DockerDialer = docker.Build
rkeDriver.LocalDialer = local.Build
rkeDriver.WrapTransportFactory = docker.WrapTransport
c.backupClient.AddLifecycle(ctx, "etcdbackup-controller", c)
go c.clusterBackupSync(ctx, clusterBackupCheckInterval)
}
func (c *Controller) Create(b *v3.EtcdBackup) (runtime.Object, error) {
if v3.BackupConditionCompleted.IsFalse(b) || v3.BackupConditionCompleted.IsTrue(b) {
return b, nil
}
cluster, err := c.clusterClient.Get(b.Spec.ClusterID, metav1.GetOptions{})
if err != nil {
return b, err
}
if !isBackupSet(cluster.Spec.RancherKubernetesEngineConfig) {
return b, fmt.Errorf("[etcd-backup] cluster doesn't have a backup config")
}
if !v3.BackupConditionCreated.IsTrue(b) {
b.Spec.Filename = getBackupFilename(b.Name, cluster)
b.Spec.BackupConfig = *cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig
v3.BackupConditionCreated.True(b)
// we set ConditionCompleted to Unknown to avoid incorrect "active" state
v3.BackupConditionCompleted.Unknown(b)
b, err = c.backupClient.Update(b)
if err != nil {
return b, err
}
}
bObj, saveErr := c.etcdSaveWithBackoff(b)
b, err = c.backupClient.Update(bObj.(*v3.EtcdBackup))
if err != nil {
return b, err
}
if saveErr != nil {
return b, fmt.Errorf("[etcd-backup] failed to perform etcd backup: %v", saveErr)
}
return b, nil
}
func (c *Controller) Remove(b *v3.EtcdBackup) (runtime.Object, error) {
logrus.Infof("[etcd-backup] Deleteing backup %s ", b.Name)
if err := c.etcdRemoveSnapshotWithBackoff(b); err != nil {
logrus.Warnf("giving up on deleting backup [%s]: %v", b.Name, err)
}
if b.Spec.BackupConfig.S3BackupConfig == nil {
return b, nil
}
// try to remove from s3 for 3 times, then give up. if we don't we get stuck forever
var delErr error
for i := 0; i < 3; i++ {
if delErr = c.deleteS3Snapshot(b); delErr == nil {
break
}
logrus.Warnf("failed to delete backup from s3: %v", delErr)
time.Sleep(5 * time.Second)
}
if delErr != nil {
logrus.Warnf("giving up on deleting backup [%s] from s3: %v", b.Name, delErr)
}
return b, nil
}
func (c *Controller) Updated(b *v3.EtcdBackup) (runtime.Object, error) {
return b, nil
}
func (c *Controller) clusterBackupSync(ctx context.Context, interval time.Duration) error {
for range ticker.Context(ctx, interval) {
clusters, err := c.clusterLister.List("", labels.NewSelector())
if err != nil {
logrus.Error(fmt.Errorf("[etcd-backup] clusterBackupSync faild: %v", err))
return err
}
for _, cluster := range clusters {
logrus.Debugf("[etcd-backup] Checking backups for cluster: %s", cluster.Name)
if err := c.doClusterBackupSync(cluster); err != nil && !apierrors.IsConflict(err) {
logrus.Error(fmt.Errorf("[etcd-backup] clusterBackupSync faild: %v", err))
}
}
}
return nil
}
func (c *Controller) doClusterBackupSync(cluster *v3.Cluster) error {
if cluster == nil || cluster.DeletionTimestamp != nil {
return nil
}
// check if the cluster is eligible for backup.
if !shouldBackup(cluster) {
return nil
}
clusterBackups, err := c.getRecuringBackupsList(cluster)
if err != nil {
return err
}
// cluster has no backups, we need to kick a new one.
if len(clusterBackups) == 0 {
logrus.Infof("[etcd-backup] Cluster [%s] has no backups, creating first backup", cluster.Name)
newBackup, err := c.createNewBackup(cluster)
if err != nil {
return fmt.Errorf("[etcd-backup] Backup create failed:%v", err)
}
logrus.Infof("[etcd-backup] Cluster [%s] new backup is created: %s", cluster.Name, newBackup.Name)
return nil
}
newestBackup := clusterBackups[0]
for _, clusterBackup := range clusterBackups[1:] {
if getBackupCompletedTime(clusterBackup).After(getBackupCompletedTime(newestBackup)) {
newestBackup = clusterBackup
}
}
// this cluster has backups, lets see if the last one is old enough
// a new backup is due if this is true
internvalHours := cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.IntervalHours
backupIntervalHours := time.Duration(internvalHours) * time.Hour
if time.Since(getBackupCompletedTime(newestBackup)) > backupIntervalHours {
newBackup, err := c.createNewBackup(cluster)
if err != nil {
return fmt.Errorf("[etcd-backup] Backup create failed:%v", err)
}
logrus.Infof("[etcd-backup] New backup created: %s", newBackup.Name)
}
// rotate old backups
return c.rotateExpiredBackups(cluster, clusterBackups)
}
func (c *Controller) createNewBackup(cluster *v3.Cluster) (*v3.EtcdBackup, error) {
newBackup := NewBackupObject(cluster, false)
v3.BackupConditionCreated.CreateUnknownIfNotExists(newBackup)
return c.backupClient.Create(newBackup)
}
func (c *Controller) etcdSaveWithBackoff(b *v3.EtcdBackup) (runtime.Object, error) {
backoff := getBackoff()
kontainerDriver, err := c.KontainerDriverLister.Get("", service.RancherKubernetesEngineDriverName)
if err != nil {
return b, err
}
bObj, err := v3.BackupConditionCompleted.Do(b, func() (runtime.Object, error) {
cluster, err := c.clusterClient.Get(b.Spec.ClusterID, metav1.GetOptions{})
if err != nil {
return b, err
}
var inErr error
err = wait.ExponentialBackoff(backoff, func() (bool, error) {
if inErr = c.backupDriver.ETCDSave(c.ctx, cluster.Name, kontainerDriver, cluster.Spec, b.Name); inErr != nil {
logrus.Warnf("%v", inErr)
return false, nil
}
return true, nil
})
return b, inErr
})
if err != nil {
v3.BackupConditionCompleted.False(bObj)
v3.BackupConditionCompleted.ReasonAndMessageFromError(bObj, err)
return bObj, err
}
return bObj, nil
}
func (c *Controller) etcdRemoveSnapshotWithBackoff(b *v3.EtcdBackup) error {
backoff := getBackoff()
kontainerDriver, err := c.KontainerDriverLister.Get("", service.RancherKubernetesEngineDriverName)
if err != nil {
return err
}
cluster, err := c.clusterClient.Get(b.Spec.ClusterID, metav1.GetOptions{})
if err != nil {
return err
}
return wait.ExponentialBackoff(backoff, func() (bool, error) {
if inErr := c.backupDriver.ETCDRemoveSnapshot(c.ctx, cluster.Name, kontainerDriver, cluster.Spec, b.Name); inErr != nil {
logrus.Warnf("%v", inErr)
return false, nil
}
return true, nil
})
}
func (c *Controller) rotateExpiredBackups(cluster *v3.Cluster, clusterBackups []*v3.EtcdBackup) error {
retention := cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.Retention
internvalHours := cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.IntervalHours
expiredBackups := getExpiredBackups(retention, internvalHours, clusterBackups)
for _, backup := range expiredBackups {
if backup.Spec.Manual {
continue
}
if err := c.backupClient.DeleteNamespaced(backup.Namespace, backup.Name, &metav1.DeleteOptions{}); err != nil {
return err
}
}
return nil
}
func NewBackupObject(cluster *v3.Cluster, manual bool) *v3.EtcdBackup {
controller := true
typeFlag := "r" // recurring is the default
providerFlag := "l" // local is the default
if manual {
typeFlag = "m" // manual backup
}
if cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.S3BackupConfig != nil {
providerFlag = "s" // s3 backup
}
prefix := fmt.Sprintf("%s-%s%s-", cluster.Name, typeFlag, providerFlag)
return &v3.EtcdBackup{
ObjectMeta: metav1.ObjectMeta{
Namespace: cluster.Name,
GenerateName: prefix,
OwnerReferences: []metav1.OwnerReference{
{
Name: cluster.Name,
UID: cluster.UID,
APIVersion: cluster.APIVersion,
Kind: cluster.Kind,
Controller: &controller,
},
},
},
Spec: v3.EtcdBackupSpec{
ClusterID: cluster.Name,
Manual: manual,
},
}
}
func getBackupFilename(snapshotName string, cluster *v3.Cluster) string {
if cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig == nil ||
cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.S3BackupConfig == nil {
return ""
}
target := cluster.Spec.RancherKubernetesEngineConfig.Services.Etcd.BackupConfig.S3BackupConfig
return fmt.Sprintf("https://s3-%s.amazonaws.com/%s/%s", target.Region, target.BucketName, snapshotName)
}
func (c *Controller) deleteS3Snapshot(b *v3.EtcdBackup) error {
if b.Spec.BackupConfig.S3BackupConfig == nil {
return fmt.Errorf("can't find S3 backup target configuration")
}
var err error
var s3Client = &minio.Client{}
var creds = &credentials.Credentials{}
var tr = &http.Transport{}
endpoint := b.Spec.BackupConfig.S3BackupConfig.Endpoint
bucketLookup := getBucketLookupType(endpoint)
bucket := b.Spec.BackupConfig.S3BackupConfig.BucketName
// no access credentials, we assume IAM roles
if b.Spec.BackupConfig.S3BackupConfig.AccessKey == "" ||
b.Spec.BackupConfig.S3BackupConfig.SecretKey == "" {
creds = credentials.NewIAM("")
if b.Spec.BackupConfig.S3BackupConfig.Endpoint == "" {
endpoint = s3Endpoint
}
} else {
accessKey := b.Spec.BackupConfig.S3BackupConfig.AccessKey
secretKey := b.Spec.BackupConfig.S3BackupConfig.SecretKey
creds = credentials.NewStatic(accessKey, secretKey, "", credentials.SignatureDefault)
}
s3Client, err = minio.NewWithOptions(endpoint, &minio.Options{
Creds: creds,
Region: b.Spec.BackupConfig.S3BackupConfig.Region,
Secure: true,
BucketLookup: bucketLookup,
})
if err != nil {
return err
}
if b.Spec.BackupConfig.S3BackupConfig.CustomCA != "" {
tr = getCustomCATransport(b.Spec.BackupConfig.S3BackupConfig.CustomCA)
s3Client.SetCustomTransport(tr)
}
exists, err := s3Client.BucketExists(bucket)
if err != nil {
return fmt.Errorf("can't access bucket: %v", err)
}
if !exists {
logrus.Errorf("bucket %s doesn't exist", bucket)
return nil
}
return s3Client.RemoveObject(bucket, b.Name)
}
func (c *Controller) getRecuringBackupsList(cluster *v3.Cluster) ([]*v3.EtcdBackup, error) {
retList := []*v3.EtcdBackup{}
backups, err := c.backupLister.List(cluster.Name, labels.NewSelector())
if err != nil {
return nil, err
}
for _, backup := range backups {
if !backup.Spec.Manual {
retList = append(retList, backup)
}
}
return retList, nil
}
func getBucketLookupType(endpoint string) minio.BucketLookupType {
if endpoint == "" {
return minio.BucketLookupAuto
}
if strings.Contains(endpoint, "aliyun") {
return minio.BucketLookupDNS
}
return minio.BucketLookupAuto
}
func getBackupCompletedTime(o runtime.Object) time.Time {
t, _ := time.Parse(time.RFC3339, v3.BackupConditionCompleted.GetLastUpdated(o))
return t
}
func getExpiredBackups(retention, internvalHours int, backups []*v3.EtcdBackup) []*v3.EtcdBackup {
expiredList := []*v3.EtcdBackup{}
toKeepDuration := time.Duration(retention*internvalHours) * time.Hour
for _, backup := range backups {
if time.Since(getBackupCompletedTime(backup)) > toKeepDuration {
expiredList = append(expiredList, backup)
}
}
return expiredList
}
func shouldBackup(cluster *v3.Cluster) bool {
// not an rke cluster, we do nothing
if cluster.Spec.RancherKubernetesEngineConfig == nil {
logrus.Debugf("[etcd-backup] [%s] is not an rke cluster, skipping..", cluster.Name)
return false
}
if !isBackupSet(cluster.Spec.RancherKubernetesEngineConfig) {
// no backend backup config
logrus.Debugf("[etcd-backup] No backup config for cluster [%s]", cluster.Name)
return false
}
// we only work with ready clusters
if !v3.ClusterConditionReady.IsTrue(cluster) {
return false
}
if !isRecurringBackupEnabled(cluster.Spec.RancherKubernetesEngineConfig) {
logrus.Debugf("[etcd-backup] Recurring backup is disabled cluster [%s]", cluster.Name)
return false
}
return true
}
func getBackoff() wait.Backoff {
return wait.Backoff{
Duration: 1000 * time.Millisecond,
Factor: 2,
Jitter: 0,
Steps: 5,
}
}
func isBackupSet(rkeConfig *v3.RancherKubernetesEngineConfig) bool {
return rkeConfig != nil && // rke cluster
rkeConfig.Services.Etcd.BackupConfig != nil // backupConfig is set
}
func isRecurringBackupEnabled(rkeConfig *v3.RancherKubernetesEngineConfig) bool {
return isBackupSet(rkeConfig) && rkeConfig.Services.Etcd.BackupConfig.Enabled != nil && *rkeConfig.Services.Etcd.BackupConfig.Enabled
}
func getCustomCATransport(ca string) *http.Transport {
certPool := x509.NewCertPool()
certPool.AppendCertsFromPEM([]byte(ca))
tr := &http.Transport{
TLSClientConfig: &tls.Config{
RootCAs: certPool,
},
}
return tr
}