Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
2ea1fc91
Commit
2ea1fc91
authored
Dec 13, 2021
by
Andy Soiron
Committed by
Kati Paizee
Dec 13, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Mention job tracking in background migration cleaning up doc
parent
3c6b6736
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
3 deletions
+6
-3
doc/development/background_migrations.md
doc/development/background_migrations.md
+6
-3
No files found.
doc/development/background_migrations.md
View file @
2ea1fc91
...
...
@@ -165,7 +165,8 @@ big JSON blob) to column `bar` (containing a string). The process for this would
roughly be as follows:
1.
Release A:
1.
Create a migration class that perform the migration for a row with a given ID.
1.
Create a migration class that performs the migration for a row with a given ID.
You can use
[
background jobs tracking
](
#background-jobs-tracking
)
to simplify cleaning up.
1.
Deploy the code for this release, this should include some code that will
schedule jobs for newly created data (for example, using an
`after_create`
hook).
1.
Schedule jobs for all existing rows in a post-deployment migration. It's
...
...
@@ -174,8 +175,10 @@ roughly be as follows:
1.
Release B:
1.
Deploy code so that the application starts using the new column and stops
scheduling jobs for newly created data.
1.
In a post-deployment migration use
`finalize_background_migration`
from
`BackgroundMigrationHelpers`
to ensure no jobs remain. This helper will:
1.
In a post-deployment migration, finalize all jobs that have not succeeded by now.
If you used
[
background jobs tracking
](
#background-jobs-tracking
)
in release A,
you can use
`finalize_background_migration`
from
`BackgroundMigrationHelpers`
to ensure no jobs remain.
This helper will:
1.
Use
`Gitlab::BackgroundMigration.steal`
to process any remaining
jobs in Sidekiq.
1.
Reschedule the migration to be run directly (that is, not through Sidekiq)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment