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
|
package gitalybackup
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"runtime"
cli "github.com/urfave/cli/v2"
"gitlab.com/gitlab-org/gitaly/v16/internal/backup"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/log"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
)
type restoreRequest struct {
serverRepository
AlwaysCreate bool `json:"always_create"`
}
type restoreSubcommand struct {
backupPath string
parallel int
parallelStorage int
layout string
removeAllRepositories []string
backupID string
serverSide bool
}
func (cmd *restoreSubcommand) flags(ctx *cli.Context) {
cmd.backupPath = ctx.String("path")
cmd.parallel = ctx.Int("parallel")
cmd.parallelStorage = ctx.Int("parallel-storage")
cmd.layout = ctx.String("layout")
cmd.removeAllRepositories = ctx.StringSlice("remove-all-repositories")
cmd.backupID = ctx.String("id")
cmd.serverSide = ctx.Bool("server-side")
}
func restoreFlags() []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: "path",
Usage: "repository backup path",
},
&cli.IntFlag{
Name: "parallel",
Usage: "maximum number of parallel backups",
Value: runtime.NumCPU(),
},
&cli.IntFlag{
Name: "parallel-storage",
Usage: "maximum number of parallel backups per storage. Note: actual parallelism when combined with `-parallel` depends on the order the repositories are received.",
Value: 2,
},
&cli.StringFlag{
Name: "layout",
Usage: "how backup files are located. Either pointer or legacy.",
Value: "pointer",
},
&cli.StringSliceFlag{
Name: "remove-all-repositories",
Usage: "comma-separated list of storage names to have all repositories removed from before restoring.",
},
&cli.StringFlag{
Name: "id",
Usage: "ID of full backup to restore. If not specified, the latest backup is restored.",
},
&cli.BoolFlag{
Name: "server-side",
Usage: "use server-side backups. Note: The feature is not ready for production use.",
Value: false,
},
}
}
func newRestoreCommand() *cli.Command {
return &cli.Command{
Name: "restore",
Usage: "Restore backup file",
Action: restoreAction,
Flags: restoreFlags(),
}
}
func restoreAction(cctx *cli.Context) error {
logger, err := log.Configure(cctx.App.Writer, "json", "")
if err != nil {
fmt.Printf("configuring logger failed: %v", err)
return err
}
ctx, err := storage.InjectGitalyServersEnv(cctx.Context)
if err != nil {
logger.Error(err.Error())
return err
}
subcmd := restoreSubcommand{}
subcmd.flags(cctx)
if err := subcmd.run(ctx, logger, cctx.App.Reader); err != nil {
logger.Error(err.Error())
return err
}
return nil
}
func (cmd *restoreSubcommand) run(ctx context.Context, logger log.Logger, stdin io.Reader) error {
pool := client.NewPool(client.WithDialOptions(client.UnaryInterceptor(), client.StreamInterceptor()))
defer func() {
_ = pool.Close()
}()
var manager backup.Strategy
if cmd.serverSide {
if cmd.backupPath != "" {
return fmt.Errorf("restore: path cannot be used with server-side backups")
}
manager = backup.NewServerSideAdapter(pool)
} else {
sink, err := backup.ResolveSink(ctx, cmd.backupPath)
if err != nil {
return fmt.Errorf("restore: resolve sink: %w", err)
}
locator, err := backup.ResolveLocator(cmd.layout, sink)
if err != nil {
return fmt.Errorf("restore: resolve locator: %w", err)
}
manager = backup.NewManager(sink, locator, pool)
}
// Get the set of existing repositories keyed by storage. We'll later use this to determine any
// dangling repos that should be removed.
existingRepos := make(map[string][]*gitalypb.Repository)
for _, storageName := range cmd.removeAllRepositories {
repos, err := manager.ListRepositories(ctx, &backup.ListRepositoriesRequest{
StorageName: storageName,
})
if err != nil {
logger.WithError(err).WithField("storage_name", storageName).Warn("failed to list repositories")
}
existingRepos[storageName] = repos
}
var opts []backup.PipelineOption
if cmd.parallel > 0 || cmd.parallelStorage > 0 {
opts = append(opts, backup.WithConcurrency(cmd.parallel, cmd.parallelStorage))
}
pipeline, err := backup.NewPipeline(logger, opts...)
if err != nil {
return fmt.Errorf("create pipeline: %w", err)
}
decoder := json.NewDecoder(stdin)
for {
var req restoreRequest
if err := decoder.Decode(&req); errors.Is(err, io.EOF) {
break
} else if err != nil {
return fmt.Errorf("restore: %w", err)
}
repo := gitalypb.Repository{
StorageName: req.StorageName,
RelativePath: req.RelativePath,
GlProjectPath: req.GlProjectPath,
}
pipeline.Handle(ctx, backup.NewRestoreCommand(manager, backup.RestoreRequest{
Server: req.ServerInfo,
Repository: &repo,
VanityRepository: &repo,
AlwaysCreate: req.AlwaysCreate,
BackupID: cmd.backupID,
}))
}
restoredRepos, err := pipeline.Done()
if err != nil {
return fmt.Errorf("restore: %w", err)
}
var removalErrors []error
for storageName, repos := range existingRepos {
for _, repo := range repos {
if _, ok := restoredRepos[storageName][backup.NewRepositoryKey(repo)]; !ok {
// If we have dangling repos (those which exist in the storage but
// weren't part of the restore), they need to be deleted so the
// state of repos in Gitaly matches that in the Rails DB.
if err := manager.RemoveRepository(ctx, &backup.RemoveRepositoryRequest{Repo: repo}); err != nil {
removalErrors = append(removalErrors, fmt.Errorf("storage_name %q relative_path %q: %w", storageName, repo.RelativePath, err))
}
}
}
}
if len(removalErrors) > 0 {
return fmt.Errorf("remove dangling repositories: %d failures encountered: %w",
len(removalErrors), errors.Join(removalErrors...))
}
return nil
}
|
