-
Notifications
You must be signed in to change notification settings - Fork 472
/
migration.go
508 lines (468 loc) · 30.8 KB
/
migration.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
497
498
499
500
501
502
503
504
505
506
507
508
package sqlstore
import (
"errors"
"fmt"
"math"
"strconv"
"github.com/blang/semver/v4"
"github.com/jinzhu/gorm"
"github.com/sirupsen/logrus"
"github.com/spiffe/spire/pkg/common/telemetry"
"github.com/spiffe/spire/pkg/common/version"
)
// Each time the database requires a migration, the "schema" version is
// increased and the migration code is added to this file. The migration code
// can be opportunistically removed after the following minor version has been
// released, since the supported upgrade path happens on minor version
// boundaries. For example, when 1.2 is released, the migrations that were
// handled by 1.1.x can be removed, since anyone upgrading from 1.0.X to 1.2.X
// will have to upgrade through 1.1.X first, which will apply the proper
// migrations before those done by 1.2.
//
// For convenience, the following table lists the schema versions for each
// SPIRE release, along with what was added in each schema change. SPIRE v0.6.2
// was the first version to introduce migrations.
//
// ================================================================================================
// | SPIRE | Schema | What changed |
// ================================================================================================
// | v0.6.2 | 1 | Soft delete support was removed |
// |*********|********|***************************************************************************|
// | v0.7.0 | 2 | Created join table between bundles and entries |
// | |--------|---------------------------------------------------------------------------|
// | | 3 | Normalized trust domain IDs across all tables |
// | |--------|---------------------------------------------------------------------------|
// | | 4 | Converted bundle data from DER to protobuf |
// |---------| | |
// | v0.7.1 | | |
// |---------|--------|---------------------------------------------------------------------------|
// | v0.7.2 | 5 | Added admin column to Entries |
// |---------| | |
// | v0.7.3 | | |
// |*********|********|***************************************************************************|
// | v0.8.0 | 6 | Added downstream column to entries |
// | |--------|---------------------------------------------------------------------------|
// | | 7 | Added expiry column to entries |
// | |--------|---------------------------------------------------------------------------|
// | | 8 | Added dns name support for entries |
// |---------|--------|---------------------------------------------------------------------------|
// | v0.8.1 | 9 | Added parent ID, SPIFFE ID and selector indices for entries |
// |---------|--------|---------------------------------------------------------------------------|
// | v0.8.2 | 10 | Added expiry index for entries |
// | |--------|---------------------------------------------------------------------------|
// | | 11 | Added federates with index for entries |
// |---------| | |
// | v0.8.3 | | |
// |---------| | |
// | v0.8.4 | | |
// |---------| | |
// | v0.8.5 | | |
// |*********|********|***************************************************************************|
// | v0.9.0 | 12 | Added support for tracking the code version in the migration table |
// | |--------|---------------------------------------------------------------------------|
// | | 13 | Added "prepared" cert columns to the attested nodes |
// |---------| | |
// | v0.9.1 | | |
// |---------| | |
// | v0.9.2 | | |
// |---------| | |
// | v0.9.3 | | |
// |---------| | |
// | v0.9.4 | | |
// |*********|********|***************************************************************************|
// | v0.10.0 | 14 | Added revision number column to entries |
// |---------| | |
// | v0.10.1 | | |
// |---------| | |
// | v0.10.2 | | |
// |*********| | |
// | v0.11.0 | | |
// |---------| | |
// | v0.11.1 | | |
// |---------| | |
// | v0.11.2 | | |
// |---------| | |
// | v0.11.2 | | |
// |*********|********|***************************************************************************|
// | v0.12.0 | 15 | Added expiry index to attested nodes |
// |---------| | |
// | v0.12.1 | | |
// |---------| | |
// | v0.12.2 | | |
// |---------| | |
// | v0.12.3 | | |
// |*********|********|***************************************************************************|
// | v1.0.0 | 16 | Added exportable identity column to entries |
// | |--------|---------------------------------------------------------------------------|
// | | 17 | Added support for Federated Trust Domains relationships |
// |---------| |---------------------------------------------------------------------------|
// | v1.0.1 | | |
// |---------| | |
// | v1.0.2 | | |
// |---------| | |
// | v1.0.3 | | |
// |*********| | |
// | v1.1.0 | | |
// |---------| | |
// | v1.1.1 | | |
// |---------| | |
// | v1.1.2 | | |
// |---------| | |
// | v1.1.3 | | |
// |---------| | |
// | v1.1.4 | | |
// |---------| | |
// | v1.1.5 | | |
// |*********|********|***************************************************************************|
// | v1.2.0 | 18 | Added hint column to entries and can_reattest column to attested nodes |
// |---------| | |
// | v1.2.1 | | |
// |---------| | |
// | v1.2.2 | | |
// |---------| | |
// | v1.2.3 | | |
// |---------| | |
// | v1.2.4 | | |
// |*********| | |
// | v1.3.0 | | |
// |---------| | |
// | v1.3.1 | | |
// |---------|--------|---------------------------------------------------------------------------|
// | v1.3.2 | 19 | Added x509_svid_ttl and jwt_svid_ttl columns to entries |
// |---------| | |
// | v1.3.3 | | |
// |---------| | |
// | v1.3.4 | | |
// |---------| | |
// | v1.3.5 | | |
// |---------| | |
// | v1.3.6 | | |
// |*********|********|***************************************************************************|
// | v1.4.0 | | |
// |---------| | |
// | v1.4.1 | | |
// |---------| | |
// | v1.4.2 | | |
// |---------| | |
// | v1.4.3 | | |
// |---------| | |
// | v1.4.4 | | |
// |---------| | |
// | v1.4.5 | | |
// |---------| | |
// | v1.4.6 | | |
// |---------| | |
// | v1.4.7 | | |
// |*********|********|***************************************************************************|
// | v1.5.0 | | |
// |---------| | |
// | v1.5.1 | | |
// |---------| | |
// | v1.5.2 | | |
// |---------| | |
// | v1.5.3 | | |
// |---------| | |
// | v1.5.4 | | |
// |---------| | |
// | v1.5.5 | | |
// |---------| | |
// | v1.5.6 | | |
// |*********|********|***************************************************************************|
// | v1.6.0 | 20 | Removed x509_svid_ttl column from registered_entries |
// | |--------|---------------------------------------------------------------------------|
// | | 21 | Added index in hint column from registered_entries |
// |---------| | |
// | v1.6.1 | | |
// |---------| | |
// | v1.6.2 | | |
// |---------| | |
// | v1.6.3 | | |
// |---------| | |
// | v1.6.4 | | |
// |---------| | |
// | v1.6.5 | | |
// |*********|********|***************************************************************************|
// | v1.7.0 | | |
// |---------| | |
// | v1.7.1 | | |
// |---------|--------|---------------------------------------------------------------------------|
// | v1.7.2 | 22 | Added registered_entries_events and attested_node_entries_events tables |
// |---------| | |
// | v1.7.3 | | |
// |---------| | |
// | v1.7.4 | | |
// |---------| | |
// | v1.7.5 | | |
// |---------| | |
// | v1.7.6 | | |
// |*********|********|***************************************************************************|
// | v1.8.0 | 23 | Added ca_journals table |
// |---------| | |
// | v1.8.1 | | |
// |---------| | |
// | v1.8.2 | | |
// |---------| | |
// | v1.8.3 | | |
// |---------| | |
// | v1.8.4 | | |
// |---------| | |
// | v1.8.5 | | |
// |---------| | |
// | v1.8.6 | | |
// |---------| | |
// | v1.8.7 | | |
// |---------| | |
// | v1.8.8 | | |
// |---------| | |
// | v1.8.9 | | |
// |---------| | |
// | v1.8.10 | | |
// |---------| | |
// | v1.8.11 | | |
// |*********|********|***************************************************************************|
// | v1.9.0 | | |
// |---------| | |
// | v1.9.1 | | |
// |---------| | |
// | v1.9.2 | | |
// |---------| | |
// | v1.9.3 | | |
// |---------| | |
// | v1.9.4 | | |
// |---------| | |
// | v1.9.5 | | |
// |---------| | |
// | v1.9.6 | | |
// |*********|********|***************************************************************************|
// | v1.10.0 | | |
// |---------| | |
// | v1.10.1 | | |
// |---------| | |
// | v1.10.2 | | |
// |---------| | |
// | v1.10.3 | | |
// |---------| | |
// | v1.10.4 | | |
// ================================================================================================
const (
// the latest schema version of the database in the code
latestSchemaVersion = 23
// lastMinorReleaseSchemaVersion is the schema version supported by the
// last minor release. When the migrations are opportunistically pruned
// from the code after a minor release, this number should be updated.
lastMinorReleaseSchemaVersion = 23
)
// the current code version
var codeVersion = semver.MustParse(version.Version())
func migrateDB(db *gorm.DB, dbType string, disableMigration bool, log logrus.FieldLogger) (err error) {
// The version comparison logic in this package supports only 0.x and 1.x versioning semantics.
// It will need to be updated prior to releasing 2.x. Ensure that we're still building a pre-2.0
// version before continuing, and fail if we're not.
if codeVersion.Major > 1 {
log.Error("Migration code needs updating for current release version")
return sqlError.New("current migration code not compatible with current release version")
}
isNew := !db.HasTable(&Migration{})
if err := db.Error; err != nil {
return sqlError.Wrap(err)
}
if isNew {
return initDB(db, dbType, log)
}
// ensure migrations table exists so we can check versioning in all cases
if err := db.AutoMigrate(&Migration{}).Error; err != nil {
return sqlError.Wrap(err)
}
migration := new(Migration)
if err := db.Assign(Migration{}).FirstOrCreate(migration).Error; err != nil {
return sqlError.Wrap(err)
}
schemaVersion := migration.Version
log = log.WithField(telemetry.Schema, strconv.Itoa(schemaVersion))
dbCodeVersion, err := getDBCodeVersion(*migration)
if err != nil {
log.WithError(err).Error("Error getting DB code version")
return sqlError.New("error getting DB code version: %v", err)
}
log = log.WithField(telemetry.VersionInfo, dbCodeVersion.String())
if schemaVersion == latestSchemaVersion {
log.Debug("Code and DB schema versions are the same. No migration needed")
// same DB schema; if current code version greater than stored, store newer code version
if codeVersion.GT(dbCodeVersion) {
newMigration := Migration{
Version: latestSchemaVersion,
CodeVersion: codeVersion.String(),
}
if err := db.Model(&Migration{}).Updates(newMigration).Error; err != nil {
return sqlError.Wrap(err)
}
}
return nil
}
if disableMigration {
if err = isDisabledMigrationAllowed(codeVersion, dbCodeVersion); err != nil {
log.WithError(err).Error("Auto-migrate must be enabled")
return sqlError.Wrap(err)
}
return nil
}
// The DB schema version can get ahead of us if the cluster is in the middle of
// an upgrade. So long as the version is compatible, log a warning and continue.
// Otherwise, we should bail out. Migration rollbacks are not supported.
if schemaVersion > latestSchemaVersion {
if !isCompatibleCodeVersion(codeVersion, dbCodeVersion) {
log.Error("Incompatible DB schema is too new for code version, upgrade SPIRE Server")
return sqlError.New("incompatible DB schema and code version")
}
log.Warn("DB schema is ahead of code version, upgrading SPIRE Server is recommended")
return nil
}
// at this point:
// - auto-migration is enabled
// - schema version of DB is behind
log.Info("Running migrations...")
for schemaVersion < latestSchemaVersion {
tx := db.Begin()
if err := tx.Error; err != nil {
return sqlError.Wrap(err)
}
schemaVersion, err = migrateVersion(tx, schemaVersion, log)
if err != nil {
tx.Rollback()
return err
}
if err := tx.Commit().Error; err != nil {
return sqlError.Wrap(err)
}
}
log.Info("Done running migrations")
return nil
}
func isDisabledMigrationAllowed(thisCodeVersion, dbCodeVersion semver.Version) error {
// If auto-migrate is disabled and we are running a compatible version (+/- 1
// minor from the stored code version) then we are done here
if !isCompatibleCodeVersion(thisCodeVersion, dbCodeVersion) {
return errors.New("auto-migration must be enabled for current DB")
}
return nil
}
func getDBCodeVersion(migration Migration) (dbCodeVersion semver.Version, err error) {
// default to 0.0.0
dbCodeVersion = semver.Version{}
// we will have a blank code version from pre-0.9, and fresh, datastores
if migration.CodeVersion != "" {
dbCodeVersion, err = semver.Parse(migration.CodeVersion)
if err != nil {
return dbCodeVersion, fmt.Errorf("unable to parse code version from DB: %w", err)
}
}
return dbCodeVersion, nil
}
func isCompatibleCodeVersion(thisCodeVersion, dbCodeVersion semver.Version) bool {
// If major version is the same and minor version is +/- 1, versions are
// compatible
if dbCodeVersion.Major != thisCodeVersion.Major || (math.Abs(float64(int64(dbCodeVersion.Minor)-int64(thisCodeVersion.Minor))) > 1) {
return false
}
return true
}
func initDB(db *gorm.DB, dbType string, log logrus.FieldLogger) (err error) {
log.Info("Initializing new database")
tx := db.Begin()
if err := tx.Error; err != nil {
return sqlError.Wrap(err)
}
tables := []any{
&Bundle{},
&AttestedNode{},
&AttestedNodeEvent{},
&NodeSelector{},
&RegisteredEntry{},
&RegisteredEntryEvent{},
&JoinToken{},
&Selector{},
&Migration{},
&DNSName{},
&FederatedTrustDomain{},
CAJournal{},
}
if err := tableOptionsForDialect(tx, dbType).AutoMigrate(tables...).Error; err != nil {
tx.Rollback()
return sqlError.Wrap(err)
}
if err := tx.Assign(Migration{
Version: latestSchemaVersion,
CodeVersion: codeVersion.String(),
}).FirstOrCreate(&Migration{}).Error; err != nil {
tx.Rollback()
return sqlError.Wrap(err)
}
if err := addFederatedRegistrationEntriesRegisteredEntryIDIndex(tx); err != nil {
return err
}
if err := tx.Commit().Error; err != nil {
return sqlError.Wrap(err)
}
return nil
}
func tableOptionsForDialect(tx *gorm.DB, dbType string) *gorm.DB {
// This allows for setting table options for a particular DB type.
// For MySQL, (for compatibility reasons) we want to make sure that
// we can support indexes on strings (varchar(255) in the DB).
if isMySQLDbType(dbType) {
return tx.Set("gorm:table_options", "ENGINE=InnoDB ROW_FORMAT=DYNAMIC DEFAULT CHARSET=utf8")
}
return tx
}
func migrateVersion(tx *gorm.DB, currVersion int, log logrus.FieldLogger) (versionOut int, err error) {
log.WithField(telemetry.VersionInfo, currVersion).Info("Migrating version")
nextVersion := currVersion + 1
if err := tx.Model(&Migration{}).Updates(Migration{
Version: nextVersion,
CodeVersion: version.Version(),
}).Error; err != nil {
return 0, sqlError.Wrap(err)
}
if currVersion < lastMinorReleaseSchemaVersion {
return 0, sqlError.New("migrating from schema version %d requires a previous SPIRE release; please follow the upgrade strategy at doc/upgrading.md", currVersion)
}
// Place all migrations handled by the current minor release here. This
// list can be opportunistically pruned after every minor release but won't
// break things if it isn't.
//
// When adding a supported migration to version XX, add a case and the
// corresponding function. The case in the following switch statement will
// look like this:
//
// case XX:
// err = migrateToVXX(tx)
//
// And the migrateToVXX function will be like this:
// func migrateToVXX(tx *gorm.DB) error {
// if err := tx.AutoMigrate(&Foo{}, &Bar{}).Error; err != nil {
// return sqlError.Wrap(err)
// }
// return nil
// }
//
switch currVersion { //nolint: gocritic // No upgrade required yet, keeping switch for future additions
default:
err = sqlError.New("no migration support for unknown schema version %d", currVersion)
}
if err != nil {
return 0, err
}
return nextVersion, nil
}
func addFederatedRegistrationEntriesRegisteredEntryIDIndex(tx *gorm.DB) error {
// GORM creates the federated_registration_entries implicitly with a primary
// key tuple (bundle_id, registered_entry_id). Unfortunately, MySQL5 does
// not use the primary key index efficiently when joining by registered_entry_id
// during registration entry list operations. We can't use gorm AutoMigrate
// to introduce the index since there is no explicit struct to add tags to
// so we have to manually create it.
if err := tx.Table("federated_registration_entries").AddIndex("idx_federated_registration_entries_registered_entry_id", "registered_entry_id").Error; err != nil {
return sqlError.Wrap(err)
}
return nil
}