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
0
Merge Requests
0
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
Boxiang Sun
gitlab-ce
Commits
989ccd71
Commit
989ccd71
authored
Sep 25, 2017
by
Sean McGivern
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document manual cleanup after background migration stealing
parent
7da72a0d
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
1 deletion
+28
-1
doc/development/background_migrations.md
doc/development/background_migrations.md
+28
-1
No files found.
doc/development/background_migrations.md
View file @
989ccd71
...
@@ -215,14 +215,29 @@ same time will ensure that both existing and new data is migrated.
...
@@ -215,14 +215,29 @@ same time will ensure that both existing and new data is migrated.
In the next release we can remove the
`after_commit`
hooks and related code. We
In the next release we can remove the
`after_commit`
hooks and related code. We
will also need to add a post-deployment migration that consumes any remaining
will also need to add a post-deployment migration that consumes any remaining
jobs. Such a migration would look like this:
jobs and manually run on any un-migrated rows. Such a migration would look like
this:
```
ruby
```
ruby
class
ConsumeRemainingExtractServicesUrlJobs
<
ActiveRecord
::
Migration
class
ConsumeRemainingExtractServicesUrlJobs
<
ActiveRecord
::
Migration
disable_ddl_transaction!
disable_ddl_transaction!
class
Service
<
ActiveRecord
::
Base
include
::
EachBatch
self
.
table_name
=
'services'
end
def
up
def
up
# This must be included
Gitlab
::
BackgroundMigration
.
steal
(
'ExtractServicesUrl'
)
Gitlab
::
BackgroundMigration
.
steal
(
'ExtractServicesUrl'
)
# This should be included, but can be skipped - see below
Service
.
where
(
url:
nil
).
each_batch
(
of:
50
)
do
|
batch
|
range
=
batch
.
pluck
(
'MIN(id)'
,
'MAX(id)'
).
first
Gitlab
::
BackgroundMigration
::
ExtractServicesUrl
.
new
.
perform
(
*
range
)
end
end
end
def
down
def
down
...
@@ -230,6 +245,15 @@ class ConsumeRemainingExtractServicesUrlJobs < ActiveRecord::Migration
...
@@ -230,6 +245,15 @@ class ConsumeRemainingExtractServicesUrlJobs < ActiveRecord::Migration
end
end
```
```
The final step runs for any un-migrated rows after all of the jobs have been
processed. This is in case a Sidekiq process running the background migrations
received SIGKILL, leading to the jobs being lost. (See
[
more reliable Sidekiq queue
][
reliable-sidekiq
]
for more information.)
If the application does not depend on the data being 100% migrated (for
instance, the data is advisory, and not mission-critical), then this final step
can be skipped.
This migration will then process any jobs for the ExtractServicesUrl migration
This migration will then process any jobs for the ExtractServicesUrl migration
and continue once all jobs have been processed. Once done you can safely remove
and continue once all jobs have been processed. Once done you can safely remove
the
`services.properties`
column.
the
`services.properties`
column.
...
@@ -254,6 +278,9 @@ for more details.
...
@@ -254,6 +278,9 @@ for more details.
1.
Make sure that background migration jobs are idempotent.
1.
Make sure that background migration jobs are idempotent.
1.
Make sure that tests you write are not false positives.
1.
Make sure that tests you write are not false positives.
1.
Make sure that if the data being migrated is critical and cannot be lost, the
clean-up migration also checks the final state of the data before completing.
[
migrations-readme
]:
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/spec/migrations/README.md
[
migrations-readme
]:
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/spec/migrations/README.md
[
issue-rspec-hooks
]:
https://gitlab.com/gitlab-org/gitlab-ce/issues/35351
[
issue-rspec-hooks
]:
https://gitlab.com/gitlab-org/gitlab-ce/issues/35351
[
reliable-sidekiq
]:
https://gitlab.com/gitlab-org/gitlab-ce/issues/36791
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