forked from percona/percona-backup-mongodb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.go
496 lines (424 loc) · 13.6 KB
/
main.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
package main
import (
"bytes"
"context"
"fmt"
"io"
"os"
"os/signal"
"sort"
"text/template"
"github.com/alecthomas/kingpin"
"github.com/percona/percona-backup-mongodb/internal/templates"
"github.com/percona/percona-backup-mongodb/internal/utils"
pbapi "github.com/percona/percona-backup-mongodb/proto/api"
pb "github.com/percona/percona-backup-mongodb/proto/messages"
"github.com/pkg/errors"
log "github.com/sirupsen/logrus"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/encoding/gzip"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/testdata"
)
// some vars are set by goreleaser
var (
Version = "dev"
Commit = "none"
Build = "date"
Branch = "master"
GoVersion = "0.0.0"
usageWriter io.Writer = os.Stdout // for testing purposes. In tests, we redirect this to a bytes buffer
conn *grpc.ClientConn
grpcCompressors = []string{
gzip.Name,
"none",
}
backuptypes = []string{
"hot",
"logical",
}
destinationTypes = []string{
"file",
"aws",
}
)
const (
defaultBackupType = "logical"
defaultConfigFile = "~/.percona-backup-mongodb.yaml"
defaultDestinationType = "file"
defaultServerAddress = "127.0.0.1:10001"
defaultServerCompressor = "gzip"
defaultSkipUserAndRoles = false
defaultTLSEnabled = false
)
type cliOptions struct {
APIToken string `yaml:"api_token" kingpin:"api-token"`
TLS bool `yaml:"tls" kingpin:"tls"`
TLSCAFile string `yaml:"tls_ca_file" kingpin:"tls-ca-file"`
ServerAddress string `yaml:"server_addr" kingpin:"server_addr"`
ServerCompressor string `yaml:"server_compressor"`
configFile string `yaml:"-"`
backup *kingpin.CmdClause
backupType string
compressionAlgorithm string
encryptionAlgorithm string
description string
storageName string
restore *kingpin.CmdClause
restoreMetadataFile string
restoreSkipUsersAndRoles bool
list *kingpin.CmdClause
listBackups *kingpin.CmdClause
listNodes *kingpin.CmdClause
listStorages *kingpin.CmdClause
showVersion *kingpin.CmdClause
showVersionFlag bool
listNodesVerbose bool
}
func main() {
cmd, opts, err := processCliArgs(os.Args[1:])
if err != nil {
if opts != nil && !opts.showVersionFlag {
kingpin.Usage()
}
if opts != nil && opts.showVersionFlag {
kingpin.Usage()
return
}
os.Exit(1)
}
grpcOpts := []grpc.DialOption{
grpc.WithUnaryInterceptor(makeUnaryInterceptor(opts.APIToken)),
grpc.WithStreamInterceptor(makeStreamInterceptor(opts.APIToken)),
}
if opts.ServerCompressor != "" && opts.ServerCompressor != "none" {
grpcOpts = append(grpcOpts, grpc.WithDefaultCallOptions(
grpc.UseCompressor(opts.ServerCompressor),
))
}
if opts.TLS {
if opts.TLSCAFile == "" {
opts.TLSCAFile = testdata.Path("ca.pem")
}
creds, err := credentials.NewClientTLSFromFile(opts.TLSCAFile, "")
if err != nil {
log.Fatalf("Failed to create TLS credentials %v", err)
}
grpcOpts = append(grpcOpts, grpc.WithTransportCredentials(creds))
} else {
grpcOpts = append(grpcOpts, grpc.WithInsecure())
}
ctx, cancel := context.WithCancel(context.Background())
conn, err = grpc.Dial(opts.ServerAddress, grpcOpts...)
if err != nil {
log.Fatalf("fail to dial: %v", err)
}
defer conn.Close()
apiClient := pbapi.NewApiClient(conn)
if err != nil {
log.Fatalf("Cannot connect to the API: %s", err)
}
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() {
<-c
cancel()
}()
switch cmd {
case "list nodes":
clients, err := connectedAgents(ctx, conn)
if err != nil {
log.Errorf("Cannot get the list of connected agents: %s", err)
break
}
if opts.listNodesVerbose {
printTemplate(templates.ConnectedNodesVerbose, clients)
} else {
printTemplate(templates.ConnectedNodes, clients)
}
case "list backups":
md, err := getAvailableBackups(ctx, conn)
if err != nil {
log.Errorf("Cannot get the list of available backups: %s", err)
break
}
if len(md) > 0 {
printTemplate(templates.AvailableBackups, md)
return
}
fmt.Println("No backups found")
case "list storage":
storages, err := listStorages(ctx)
if err != nil {
log.Fatalf("Cannot get storage list: %s", err)
}
printTemplate(templates.AvailableStorages, storages)
case "run backup":
err := startBackup(ctx, apiClient, opts)
if err != nil {
log.Fatalf("Cannot send the StartBackup command to the gRPC server: %s", err)
}
log.Println("Backup completed")
case "run restore":
fmt.Println("restoring")
err := restoreBackup(ctx, apiClient, opts)
if err != nil {
log.Fatalf("Cannot send the RestoreBackup command to the gRPC server: %s", err)
}
log.Println("Restore completed")
case "version":
print(versionMessage())
default:
log.Fatalf("Unknown command %q", cmd)
}
cancel()
}
func connectedAgents(ctx context.Context, conn *grpc.ClientConn) ([]*pbapi.Client, error) {
apiClient := pbapi.NewApiClient(conn)
stream, err := apiClient.GetClients(ctx, &pbapi.Empty{})
if err != nil {
return nil, err
}
clients := []*pbapi.Client{}
for {
msg, err := stream.Recv()
if err != nil {
if err == io.EOF {
break
}
return nil, errors.Wrap(err, "Cannot get the connected agents list")
}
clients = append(clients, msg)
}
if err := stream.CloseSend(); err != nil {
return nil, errors.Wrap(err, "cannot close stream for connectedAgents function")
}
sort.Slice(clients, func(i, j int) bool { return clients[i].NodeName < clients[j].NodeName })
return clients, nil
}
func getAvailableBackups(ctx context.Context, conn *grpc.ClientConn) (map[string]*pb.BackupMetadata, error) {
apiClient := pbapi.NewApiClient(conn)
stream, err := apiClient.BackupsMetadata(ctx, &pbapi.BackupsMetadataParams{})
if err != nil {
return nil, err
}
mds := make(map[string]*pb.BackupMetadata)
for {
msg, err := stream.Recv()
if err != nil {
if err == io.EOF {
break
}
return nil, errors.Wrap(err, "Cannot get the connected agents list")
}
mds[msg.Filename] = msg.Metadata
}
return mds, nil
}
// This function is used by autocompletion. Currently, when it is called, the gRPC connection is nil
// because command line parameters havent been processed yet.
// Maybe in the future, we could read the defaults from a config file. For now, just try to connect
// to a server running on the local host
func listAvailableBackups() (backups []string) {
var err error
if conn == nil {
conn, err = grpc.Dial(defaultServerAddress, []grpc.DialOption{grpc.WithInsecure()}...)
if err != nil {
return
}
defer conn.Close()
}
mds, err := getAvailableBackups(context.TODO(), conn)
if err != nil {
return
}
for name, md := range mds {
backup := fmt.Sprintf("%s -> %s", name, md.Description)
backups = append(backups, backup)
}
return
}
func listStorages(ctx context.Context) ([]pbapi.StorageInfo, error) {
apiClient := pbapi.NewApiClient(conn)
stream, err := apiClient.ListStorages(ctx, &pbapi.ListStoragesParams{})
if err != nil {
return nil, errors.Wrap(err, "Cannot list remote storage")
}
storages := []pbapi.StorageInfo{}
for {
msg, err := stream.Recv()
if err != nil {
if err == io.EOF {
break
}
return nil, errors.Wrap(err, "A problem was found while receiving storage list from the server")
}
storages = append(storages, *msg)
}
return storages, nil
}
func startBackup(ctx context.Context, apiClient pbapi.ApiClient, opts *cliOptions) error {
msg := &pbapi.RunBackupParams{
CompressionType: pbapi.CompressionType_COMPRESSION_TYPE_NO_COMPRESSION,
Cypher: pbapi.Cypher_CYPHER_NO_CYPHER,
Description: opts.description,
StorageName: opts.storageName,
}
switch opts.backupType {
case "logical":
msg.BackupType = pbapi.BackupType_BACKUP_TYPE_LOGICAL
case "hot":
msg.BackupType = pbapi.BackupType_BACKUP_TYPE_HOTBACKUP
default:
return fmt.Errorf("backup type %q is invalid", opts.backupType)
}
switch opts.compressionAlgorithm {
case "none", "":
case "gzip":
msg.CompressionType = pbapi.CompressionType_COMPRESSION_TYPE_GZIP
default:
return fmt.Errorf("compression algorithm %q is invalid", opts.compressionAlgorithm)
}
switch opts.encryptionAlgorithm {
case "":
default:
return fmt.Errorf("encryption is not implemented yet")
}
_, err := apiClient.RunBackup(ctx, msg)
if err != nil {
return err
}
return nil
}
func restoreBackup(ctx context.Context, apiClient pbapi.ApiClient, opts *cliOptions) error {
msg := &pbapi.RunRestoreParams{
MetadataFile: opts.restoreMetadataFile,
SkipUsersAndRoles: opts.restoreSkipUsersAndRoles,
StorageName: opts.storageName,
}
_, err := apiClient.RunRestore(ctx, msg)
if err != nil {
return err
}
return nil
}
func printTemplate(tpl string, data interface{}) {
var b bytes.Buffer
tmpl := template.Must(template.New("").Parse(tpl))
if err := tmpl.Execute(&b, data); err != nil {
log.Fatal(err)
}
print(b.String())
}
func processCliArgs(args []string) (string, *cliOptions, error) {
app := kingpin.New("pbmctl", "Percona Backup for MongoDB CLI")
///app.Version(versionMessage())
runCmd := app.Command("run", "Start a new backup or restore process")
versionCmd := app.Command("version", "Show program version and exit")
listCmd := app.Command("list", "List objects (connected nodes, backups, etc)")
listBackupsCmd := listCmd.Command("backups", "List backups")
listNodesCmd := listCmd.Command("nodes", "List objects (connected nodes, backups, etc)")
listStoragesCmd := listCmd.Command("storage", "List available remote storage")
backupCmd := runCmd.Command("backup", "Start a backup")
restoreCmd := runCmd.Command("restore", "Restore a backup given a metadata file name")
opts := &cliOptions{
list: listCmd,
listBackups: listBackupsCmd,
listNodes: listNodesCmd,
listStorages: listStoragesCmd,
backup: backupCmd,
restore: restoreCmd,
showVersion: versionCmd,
}
app.Flag("config-file", "Config file name").
Short('c').StringVar(&opts.configFile)
//app.Flag("version", "Show version and exit").
// BoolVar(&opts.showVersionFlag)
app.Flag("api-token", "Security token to use when connecting to the backup coordinator").
StringVar(&opts.APIToken)
listNodesCmd.Flag("verbose", "Include extra node info").
BoolVar(&opts.listNodesVerbose)
backupCmd.Flag("backup-type", "Backup type (logical or hot)").
Default(defaultBackupType).
EnumVar(&opts.backupType, backuptypes...)
backupCmd.Flag("compression-algorithm", "Compression algorithm used for the backup").
StringVar(&opts.compressionAlgorithm)
backupCmd.Flag("encryption-algorithm", "Encryption algorithm used for the backup").
StringVar(&opts.encryptionAlgorithm)
backupCmd.Flag("description", "Backup description").
Required().
StringVar(&opts.description)
backupCmd.Flag("storage", "Storage Name").
Required().
StringVar(&opts.storageName)
restoreCmd.Arg("metadata-file", "Metadata file having the backup info for restore").
HintAction(listAvailableBackups).
Required().
StringVar(&opts.restoreMetadataFile)
restoreCmd.Flag("skip-users-and-roles", "Do not restore users and roles").
Default(fmt.Sprintf("%v", defaultSkipUserAndRoles)).
BoolVar(&opts.restoreSkipUsersAndRoles)
restoreCmd.Flag("storage", "Storage Name").
Required().
StringVar(&opts.storageName)
app.Flag("server-address", "Backup coordinator address (host:port)").
Default(defaultServerAddress).
Short('s').
StringVar(&opts.ServerAddress)
app.Flag("server-compressor", "Backup coordinator gRPC compression (gzip or none)").
Default(defaultServerCompressor).
EnumVar(&opts.ServerCompressor, grpcCompressors...)
app.Flag("tls", "Connection uses TLS if true, else plain TCP").
Default(fmt.Sprintf("%v", defaultTLSEnabled)).
BoolVar(&opts.TLS)
app.Flag("tls-ca-file", "The file containing the CA root cert file").
StringVar(&opts.TLSCAFile)
app.Terminate(nil) // Don't call os.Exit() on errors
app.UsageWriter(usageWriter)
app.PreAction(func(c *kingpin.ParseContext) error {
if opts.configFile == "" {
fn := utils.Expand(defaultConfigFile)
if _, err := os.Stat(fn); err != nil {
return nil
}
opts.configFile = fn
}
return utils.LoadOptionsFromFile(opts.configFile, c, opts)
})
cmd, err := app.DefaultEnvars().Parse(args)
if err != nil {
return "", opts, err
}
if cmd == "" {
return "", opts, fmt.Errorf("invalid command")
}
return cmd, opts, nil
}
func makeUnaryInterceptor(token string) func(ctx context.Context, method string, req interface{}, reply interface{},
cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
return func(ctx context.Context, method string, req interface{}, reply interface{},
cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
md := metadata.Pairs("authorization", "bearer "+token)
ctx = metadata.NewOutgoingContext(ctx, md)
err := invoker(ctx, method, req, reply, cc, opts...)
return err
}
}
func makeStreamInterceptor(token string) func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn,
method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
return func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string,
streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
md := metadata.Pairs("authorization", "bearer "+token)
ctx = metadata.NewOutgoingContext(ctx, md)
return streamer(ctx, desc, cc, method, opts...)
}
}
func versionMessage() string {
msg := "Version : " + Version + "\n"
msg += "Commit : " + Commit + "\n"
msg += "Build : " + Build + "\n"
msg += "Branch : " + Branch + "\n"
msg += "Go version: " + GoVersion + "\n"
return msg
}