forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
migrations.go
426 lines (389 loc) · 14.1 KB
/
migrations.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
// Copyright 2016 The Cockroach Authors.
//
// 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 sqlmigrations
import (
"time"
"golang.org/x/net/context"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/internal/client"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/sql"
"github.com/cockroachdb/cockroach/pkg/sql/sqlbase"
"github.com/cockroachdb/cockroach/pkg/util/envutil"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/retry"
"github.com/cockroachdb/cockroach/pkg/util/stop"
"github.com/cockroachdb/cockroach/pkg/util/timeutil"
"github.com/pkg/errors"
)
var (
leaseDuration = time.Minute
leaseRefreshInterval = leaseDuration / 5
)
// backwardCompatibleMigrations is a hard-coded list of migrations to be run on
// startup. They will always be run from top-to-bottom, and because they are
// assumed to be backward-compatible, they will be run regardless of what other
// node versions are currently running within the cluster.
var backwardCompatibleMigrations = []migrationDescriptor{
{
name: "default UniqueID to uuid_v4 in system.eventlog",
workFn: eventlogUniqueIDDefault,
},
{
name: "create system.jobs table",
workFn: createJobsTable,
newDescriptors: 1,
newRanges: 1,
},
{
name: "create system.settings table",
workFn: createSettingsTable,
newDescriptors: 1,
newRanges: 0, // it lives in gossip range.
},
{
name: "enable diagnostics reporting",
workFn: optInToDiagnosticsStatReporting,
},
{
name: "establish conservative dependencies for views #17280 #17269 #17306",
workFn: repopulateViewDeps,
},
{
name: "create system.sessions table",
workFn: createWebSessionsTable,
newDescriptors: 1,
// The table ID for the sessions table is greater than the previous
// table ID by 4 (3 IDs were reserved for non-table entities).
newRanges: 4,
},
}
// migrationDescriptor describes a single migration hook that's used to modify
// some part of the cluster state when the CockroachDB version is upgraded.
// See docs/RFCs/cluster_upgrade_tool.md for details.
type migrationDescriptor struct {
// name must be unique amongst all hard-coded migrations.
name string
// workFn must be idempotent so that we can safely re-run it if a node failed
// while running it.
workFn func(context.Context, runner) error
// newRanges and newDescriptors are the number of additional ranges/descriptors
// that would be added by this migration in a fresh cluster. This is needed to
// automate certain tests, which check the number of ranges/descriptors
// present on server bootup.
newRanges, newDescriptors int
}
type runner struct {
db db
sqlExecutor *sql.Executor
memMetrics *sql.MemoryMetrics
}
func (r *runner) newRootSession(ctx context.Context) *sql.Session {
args := sql.SessionArgs{User: security.NodeUser}
s := sql.NewSession(ctx, args, r.sqlExecutor, nil, r.memMetrics)
s.StartUnlimitedMonitor()
return s
}
// leaseManager is defined just to allow us to use a fake client.LeaseManager
// when testing this package.
type leaseManager interface {
AcquireLease(ctx context.Context, key roachpb.Key) (*client.Lease, error)
ExtendLease(ctx context.Context, l *client.Lease) error
ReleaseLease(ctx context.Context, l *client.Lease) error
TimeRemaining(l *client.Lease) time.Duration
}
// db is defined just to allow us to use a fake client.DB when testing this
// package.
type db interface {
Scan(ctx context.Context, begin, end interface{}, maxRows int64) ([]client.KeyValue, error)
Put(ctx context.Context, key, value interface{}) error
Txn(ctx context.Context, retryable func(ctx context.Context, txn *client.Txn) error) error
}
// Manager encapsulates the necessary functionality for handling migrations
// of data in the cluster.
type Manager struct {
stopper *stop.Stopper
leaseManager leaseManager
db db
sqlExecutor *sql.Executor
memMetrics *sql.MemoryMetrics
}
// NewManager initializes and returns a new Manager object.
func NewManager(
stopper *stop.Stopper,
db *client.DB,
executor *sql.Executor,
clock *hlc.Clock,
memMetrics *sql.MemoryMetrics,
clientID string,
) *Manager {
opts := client.LeaseManagerOptions{
ClientID: clientID,
LeaseDuration: leaseDuration,
}
return &Manager{
stopper: stopper,
leaseManager: client.NewLeaseManager(db, clock, opts),
db: db,
sqlExecutor: executor,
memMetrics: memMetrics,
}
}
// AdditionalInitialDescriptors returns the number of system descriptors and
// ranges that have been added by migrations. This is needed for certain tests,
// which check the number of ranges at node startup.
//
// NOTE: This value may be out-of-date if another node is actively running
// migrations, and so should only be used in test code where the migration
// lifecycle is tightly controlled.
func AdditionalInitialDescriptors(
ctx context.Context, db db,
) (descriptors int, ranges int, _ error) {
completedMigrations, err := getCompletedMigrations(ctx, db)
if err != nil {
return 0, 0, err
}
for _, migration := range backwardCompatibleMigrations {
key := migrationKey(migration)
if _, ok := completedMigrations[string(key)]; ok {
descriptors += migration.newDescriptors
ranges += migration.newRanges
}
}
return descriptors, ranges, nil
}
// EnsureMigrations should be run during node startup to ensure that all
// required migrations have been run (and running all those that are definitely
// safe to run).
func (m *Manager) EnsureMigrations(ctx context.Context) error {
// First, check whether there are any migrations that need to be run.
completedMigrations, err := getCompletedMigrations(ctx, m.db)
if err != nil {
return err
}
allMigrationsCompleted := true
for _, migration := range backwardCompatibleMigrations {
key := migrationKey(migration)
if _, ok := completedMigrations[string(key)]; !ok {
allMigrationsCompleted = false
}
}
if allMigrationsCompleted {
return nil
}
// If there are any, grab the migration lease to ensure that only one
// node is ever doing migrations at a time.
// Note that we shouldn't ever let client.LeaseNotAvailableErrors cause us
// to stop trying, because if we return an error the server will be shut down,
// and this server being down may prevent the leaseholder from finishing.
var lease *client.Lease
if log.V(1) {
log.Info(ctx, "trying to acquire lease")
}
for r := retry.StartWithCtx(ctx, base.DefaultRetryOptions()); r.Next(); {
lease, err = m.leaseManager.AcquireLease(ctx, keys.MigrationLease)
if err == nil {
break
}
log.Errorf(ctx, "failed attempt to acquire migration lease: %s", err)
}
if err != nil {
return errors.Wrapf(err, "failed to acquire lease for running necessary migrations")
}
// Ensure that we hold the lease throughout the migration process and release
// it when we're done.
done := make(chan interface{}, 1)
defer func() {
done <- nil
if log.V(1) {
log.Info(ctx, "trying to release the lease")
}
if err := m.leaseManager.ReleaseLease(ctx, lease); err != nil {
log.Errorf(ctx, "failed to release migration lease: %s", err)
}
}()
if err := m.stopper.RunAsyncTask(ctx, "migrations.Manager: lease watcher",
func(ctx context.Context) {
select {
case <-done:
return
case <-time.After(leaseRefreshInterval):
if err := m.leaseManager.ExtendLease(ctx, lease); err != nil {
log.Warningf(ctx, "unable to extend ownership of expiration lease: %s", err)
}
if m.leaseManager.TimeRemaining(lease) < leaseRefreshInterval {
// Do one last final check of whether we're done - it's possible that
// ReleaseLease can sneak in and execute ahead of ExtendLease even if
// the ExtendLease started first (making for an unexpected value error),
// and doing this final check can avoid unintended shutdowns.
select {
case <-done:
return
default:
// Note that we may be able to do better than this by influencing the
// deadline of migrations' transactions based on the lease expiration
// time, but simply kill the process for now for the sake of simplicity.
log.Fatal(ctx, "not enough time left on migration lease, terminating for safety")
}
}
}
}); err != nil {
return err
}
// Re-get the list of migrations in case any of them were completed between
// our initial check and our grabbing of the lease.
completedMigrations, err = getCompletedMigrations(ctx, m.db)
if err != nil {
return err
}
startTime := timeutil.Now().String()
r := runner{
db: m.db,
sqlExecutor: m.sqlExecutor,
memMetrics: m.memMetrics,
}
for _, migration := range backwardCompatibleMigrations {
key := migrationKey(migration)
if _, ok := completedMigrations[string(key)]; ok {
continue
}
if log.V(1) {
log.Infof(ctx, "running migration %q", migration.name)
}
if err := migration.workFn(ctx, r); err != nil {
return errors.Wrapf(err, "failed to run migration %q", migration.name)
}
if log.V(1) {
log.Infof(ctx, "trying to persist record of completing migration %s", migration.name)
}
if err := m.db.Put(ctx, key, startTime); err != nil {
return errors.Wrapf(err, "failed to persist record of completing migration %q",
migration.name)
}
}
return nil
}
func getCompletedMigrations(ctx context.Context, db db) (map[string]struct{}, error) {
if log.V(1) {
log.Info(ctx, "trying to get the list of completed migrations")
}
keyvals, err := db.Scan(ctx, keys.MigrationPrefix, keys.MigrationKeyMax, 0 /* maxRows */)
if err != nil {
return nil, errors.Wrapf(err, "failed to get list of completed migrations")
}
completedMigrations := make(map[string]struct{})
for _, keyval := range keyvals {
completedMigrations[string(keyval.Key)] = struct{}{}
}
return completedMigrations, nil
}
func migrationKey(migration migrationDescriptor) roachpb.Key {
return append(keys.MigrationPrefix, roachpb.RKey(migration.name)...)
}
func checkQueryResults(results []sql.Result, numResults int) error {
for _, result := range results {
if result.Err != nil {
return result.Err
}
}
if a, e := len(results), numResults; a != e {
return errors.Errorf("number of results %d != expected %d", a, e)
}
return nil
}
func eventlogUniqueIDDefault(ctx context.Context, r runner) error {
const alterStmt = `ALTER TABLE system.eventlog ALTER COLUMN "uniqueID" SET DEFAULT uuid_v4();`
// System tables can only be modified by a privileged internal user.
session := r.newRootSession(ctx)
defer session.Finish(r.sqlExecutor)
// Retry a limited number of times because returning an error and letting
// the node kill itself is better than holding the migration lease for an
// arbitrarily long time.
var err error
for retry := retry.Start(retry.Options{MaxRetries: 5}); retry.Next(); {
res := r.sqlExecutor.ExecuteStatements(session, alterStmt, nil)
defer res.Close(ctx)
err = checkQueryResults(res.ResultList, 1)
if err == nil {
break
}
log.Warningf(ctx, "failed attempt to update system.eventlog schema: %s", err)
}
return err
}
func createJobsTable(ctx context.Context, r runner) error {
return createSystemTable(ctx, r, sqlbase.JobsTable)
}
func createSettingsTable(ctx context.Context, r runner) error {
return createSystemTable(ctx, r, sqlbase.SettingsTable)
}
func createWebSessionsTable(ctx context.Context, r runner) error {
return createSystemTable(ctx, r, sqlbase.WebSessionsTable)
}
func createSystemTable(ctx context.Context, r runner, desc sqlbase.TableDescriptor) error {
// We install the table at the KV layer so that we can choose a known ID in
// the reserved ID space. (The SQL layer doesn't allow this.)
err := r.db.Txn(ctx, func(ctx context.Context, txn *client.Txn) error {
b := txn.NewBatch()
b.CPut(sqlbase.MakeNameMetadataKey(desc.GetParentID(), desc.GetName()), desc.GetID(), nil)
b.CPut(sqlbase.MakeDescMetadataKey(desc.GetID()), sqlbase.WrapDescriptor(&desc), nil)
if err := txn.SetSystemConfigTrigger(); err != nil {
return err
}
return txn.Run(ctx, b)
})
if err != nil {
// CPuts only provide idempotent inserts if we ignore the errors that arise
// when the condition isn't met.
if _, ok := err.(*roachpb.ConditionFailedError); ok {
return nil
}
}
return err
}
var reportingOptOut = envutil.EnvOrDefaultBool("COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING", false)
func optInToDiagnosticsStatReporting(ctx context.Context, r runner) error {
const setStmt = "SET CLUSTER SETTING diagnostics.reporting.enabled = true"
// We're opting-out of the automatic opt-in. See discussion in updates.go.
if reportingOptOut {
return nil
}
// System tables can only be modified by a privileged internal user.
session := r.newRootSession(ctx)
defer session.Finish(r.sqlExecutor)
// Retry a limited number of times because returning an error and letting
// the node kill itself is better than holding the migration lease for an
// arbitrarily long time.
var err error
for retry := retry.Start(retry.Options{MaxRetries: 5}); retry.Next(); {
res := r.sqlExecutor.ExecuteStatements(session, setStmt, nil)
err = checkQueryResults(res.ResultList, 1)
if err == nil {
break
}
log.Warningf(ctx, "failed attempt to update setting: %v", err)
}
return err
}
// repopulateViewDeps recomputes the dependencies of all views, as
// they might not have been computed properly previously.
// (#17269 #17306)
func repopulateViewDeps(ctx context.Context, r runner) error {
return r.db.Txn(ctx, func(ctx context.Context, txn *client.Txn) error {
return sql.RecomputeViewDependencies(ctx, txn, r.sqlExecutor)
})
}