forked from vmware-tanzu/velero
-
Notifications
You must be signed in to change notification settings - Fork 0
/
migrate_backups.go
255 lines (213 loc) · 9.21 KB
/
migrate_backups.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
package migratebackups
import (
"bytes"
"compress/gzip"
"encoding/json"
"io"
"io/ioutil"
"log"
"path"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
v1 "github.com/heptio/velero/pkg/apis/velero/v1"
"github.com/heptio/velero/pkg/client"
"github.com/heptio/velero/pkg/cloudprovider"
"github.com/heptio/velero/pkg/persistence"
"github.com/heptio/velero/pkg/plugin"
"github.com/heptio/velero/pkg/util/encode"
"github.com/heptio/velero/pkg/volume"
)
func NewCommand(f client.Factory) *cobra.Command {
var (
backupLocation = "default"
snapshotLocation = ""
)
c := &cobra.Command{
Use: "migrate-backups",
Short: "Rewrite metadata for backups created before v0.11 to match the current format in object storage",
Long: `
The "velero migrate-backups" command rewrites metadata for backups created before v0.11 to match the current format in object storage. It
does this by converting the ark-backup.json files to velero-backup.json files, and creating <backup name>-volumesnapshots.json.gz
files to replace the contents of backups' status.volumeBackups field.
"velero migrate-backups" is *ONLY* appropriate for use if you're running velero v0.11.x on the server, and you've already followed the migration steps here:
https://heptio.github.io/velero/v0.11.0/migrating-to-velero.`,
Example: ` # rewrite any pre-v0.11 backups in the backup storage location named "default"
velero migrate-backups --backup-location default
# rewrite pre-v0.10 backups in the backup storage location named "default", and indicate that
# the volume snapshots associated with the backup are in the volume snapshot location named "foo"
velero migrate-backups --backup-location default --snapshot-location foo
`,
Run: func(c *cobra.Command, args []string) {
log.Println("+ PREPARING")
log.Println(" + getting Velero API client")
client, err := f.Client()
if err != nil {
log.Fatalf(" + error getting Velero API client! %v\n", err)
}
log.Printf(" + getting backup storage location %q\n", backupLocation)
bsl, err := client.VeleroV1().BackupStorageLocations(f.Namespace()).Get(backupLocation, metav1.GetOptions{})
if err != nil {
log.Fatalf(" + error getting backup storage location! %v\n", err)
}
log.Println(" + discovering plugins")
logger := logrus.StandardLogger()
logger.Out = ioutil.Discard
registry := plugin.NewRegistry("", logger, logrus.InfoLevel)
if err := registry.DiscoverPlugins(); err != nil {
log.Fatalf(" + error discovering plugins! %v\n", err)
}
log.Println(" + creating plugin manager")
pluginManager := plugin.NewManager(logger, logrus.InfoLevel, registry)
defer pluginManager.CleanupClients()
log.Println(" + getting object store plugin")
objectStore, err := pluginManager.GetObjectStore(bsl.Spec.Provider)
if err != nil {
log.Fatalf(" +error getting object store plugin! %v\n", err)
}
log.Println(" + initializing object store plugin")
if err := objectStore.Init(bsl.Spec.Config); err != nil {
log.Fatalf(" +error initializing object store plugin! %v\n", err)
}
log.Println(" + getting backup store")
backupStore, err := persistence.NewObjectBackupStore(bsl, pluginManager, logger)
if err != nil {
log.Fatalf(" +error getting backup store! %v\n", err)
}
log.Println(" + listing backups in backup store")
backupNames, err := backupStore.ListBackups()
if err != nil {
log.Fatalf(" + error listing backups! %v\n", err)
}
log.Println("+ PROCESSING BACKUPS")
var totalCount, currentCount, succeededCount int
for _, backupName := range backupNames {
totalCount++
log.Printf(" + processing backup %q\n", backupName)
log.Println(" + checking whether backup is in the current format")
current, err := isCurrent(backupName, objectStore, bsl)
if err != nil {
log.Printf(" + error checking whether backup is in the current format! %v\n", err)
continue
}
if current {
currentCount++
log.Printf(" + backup is already in the current format!\n")
continue
}
log.Printf(" + starting migration of backup to current format\n")
if err := migrateBackup(backupName, backupStore, objectStore, bsl, snapshotLocation); err != nil {
log.Printf(" + error migrating backup! %v\n", err)
continue
}
succeededCount++
log.Printf(" + migration of backup complete!\n")
}
log.Printf("+ MIGRATION SUMMARY\n")
log.Printf(" + total backups processed:\t%d\n", totalCount)
log.Printf(" + already current backups:\t%d\n", currentCount)
log.Printf(" + successful migrations:\t\t%d\n", succeededCount)
log.Printf(" + failed migrations:\t\t%d\n", totalCount-currentCount-succeededCount)
},
}
c.Flags().StringVar(&backupLocation, "backup-location", backupLocation, "backup storage location to process migration for")
c.Flags().StringVar(&snapshotLocation, "snapshot-location", snapshotLocation, "volume snapshot location to assign volume snapshots to (if found in backup.status.volumeBackups)")
return c
}
func isCurrent(backupName string, objectStore cloudprovider.ObjectStore, bsl *v1.BackupStorageLocation) (bool, error) {
prefix := path.Join(bsl.Spec.ObjectStorage.Prefix, "backups", backupName) + "/"
keys, err := objectStore.ListObjects(bsl.Spec.ObjectStorage.Bucket, prefix)
if err != nil {
return false, errors.Wrapf(err, "error listing objects in bucket %q under prefix %q", bsl.Spec.ObjectStorage.Bucket, prefix)
}
currentMetadataKey := prefix + "velero-backup.json"
for _, key := range keys {
if key == currentMetadataKey {
return true, nil
}
}
return false, nil
}
func migrateBackup(
backupName string,
backupStore persistence.BackupStore,
objectStore cloudprovider.ObjectStore,
bsl *v1.BackupStorageLocation,
vslName string,
) error {
log.Printf(" + getting ark-backup.json metadata file from object storage\n")
backup, err := backupStore.GetBackupMetadata(backupName)
if err != nil {
return errors.Wrap(err, "error getting backup metadata file from object storage")
}
var volumeSnapshots []*volume.Snapshot
log.Printf(" + processing backup.status.volumeBackups\n")
for pvName, snapshotInfo := range backup.Status.VolumeBackups {
log.Printf(" + processing backup.status.volumeBackups[%s]\n", pvName)
volumeSnapshot := &volume.Snapshot{
Spec: volume.SnapshotSpec{
BackupName: backupName,
BackupUID: string(backup.UID),
Location: vslName,
PersistentVolumeName: pvName,
VolumeType: snapshotInfo.Type,
VolumeAZ: snapshotInfo.AvailabilityZone,
VolumeIOPS: snapshotInfo.Iops,
},
Status: volume.SnapshotStatus{
ProviderSnapshotID: snapshotInfo.SnapshotID,
Phase: volume.SnapshotPhaseCompleted,
},
}
volumeSnapshots = append(volumeSnapshots, volumeSnapshot)
}
backup.Status.VolumeSnapshotsAttempted = len(volumeSnapshots)
backup.Status.VolumeSnapshotsCompleted = len(volumeSnapshots)
backup.Status.VolumeBackups = nil
log.Printf(" + encoding volume snapshots as %s-volumesnapshots.json.gz\n", backupName)
volumeSnapshotsReader, err := encodeVolumeSnapshots(volumeSnapshots)
if err != nil {
return errors.Wrap(err, "error writing volume snapshots to gzipped JSON file")
}
log.Printf(" + uploading %s-volumesnapshots.json.gz to object storage\n", backupName)
volumeSnapshotsKey := path.Join(bsl.Spec.ObjectStorage.Prefix, "backups", backupName, backupName+"-volumesnapshots.json.gz")
if err := objectStore.PutObject(bsl.Spec.ObjectStorage.Bucket, volumeSnapshotsKey, volumeSnapshotsReader); err != nil {
return errors.Wrap(err, "error uploading volumesnapshots.json.gz file to object storage")
}
log.Printf(" + encoding backup metadata to velero-backup.json\n")
backupMetadataReader, err := encodeBackup(backup)
if err != nil {
return errors.Wrap(err, "error encoding backup metadata to JSON")
}
log.Printf(" + uploading velero-backup.json to object storage\n")
backupMetadataKey := path.Join(bsl.Spec.ObjectStorage.Prefix, "backups", backup.Name, "velero-backup.json")
if err := objectStore.PutObject(bsl.Spec.ObjectStorage.Bucket, backupMetadataKey, backupMetadataReader); err != nil {
return errors.Wrap(err, "error uploading velero-backup.json file to object storage")
}
log.Printf(" + deleting ark-backup.json from object storage\n")
legacyMetadataKey := path.Join(bsl.Spec.ObjectStorage.Prefix, "backups", backup.Name, "ark-backup.json")
if err := objectStore.DeleteObject(bsl.Spec.ObjectStorage.Bucket, legacyMetadataKey); err != nil {
return errors.Wrap(err, "error deleting ark-backup.json file from object storage")
}
return nil
}
func encodeVolumeSnapshots(volumeSnapshots []*volume.Snapshot) (io.Reader, error) {
buf := new(bytes.Buffer)
gzw := gzip.NewWriter(buf)
defer gzw.Close()
if err := json.NewEncoder(gzw).Encode(volumeSnapshots); err != nil {
return nil, err
}
if err := gzw.Close(); err != nil {
return nil, err
}
return buf, nil
}
func encodeBackup(backup *v1.Backup) (io.Reader, error) {
buf := new(bytes.Buffer)
if err := encode.EncodeTo(backup, "json", buf); err != nil {
return nil, err
}
return buf, nil
}