Commit e480aa14 authored by Kati Paizee's avatar Kati Paizee

Merge branch 'more-prominent-batched-bgm-docs' into 'master'

Docs: Highlight importance of batched background migrations

See merge request gitlab-org/gitlab!66434
parents ca635803 5be1ac79
...@@ -72,13 +72,21 @@ from the chart version to GitLab version to determine the [upgrade path](#upgrad ...@@ -72,13 +72,21 @@ from the chart version to GitLab version to determine the [upgrade path](#upgrad
## Checking for background migrations before upgrading ## Checking for background migrations before upgrading
Certain major/minor releases may require a set of background migrations to be Certain major/minor releases may require different migrations to be
finished. The number of remaining migrations jobs can be found by running the finished before you update to the newer version.
following command:
**For GitLab 14.0 and newer**
To check the status of [batched background migrations](../user/admin_area/monitoring/background_migrations.md):
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Monitoring > Background Migrations**.
![queued batched background migrations table](img/batched_background_migrations_queued_v14_0.png)
**For Omnibus installations** **For Omnibus installations**
If using GitLab 12.9 and newer, run: If using GitLab 12.9 and newer, also run:
```shell ```shell
sudo gitlab-rails runner -e production 'puts Gitlab::BackgroundMigration.remaining' sudo gitlab-rails runner -e production 'puts Gitlab::BackgroundMigration.remaining'
...@@ -107,12 +115,6 @@ Sidekiq::Queue.new("background_migration").size ...@@ -107,12 +115,6 @@ Sidekiq::Queue.new("background_migration").size
Sidekiq::ScheduledSet.new.select { |r| r.klass == 'BackgroundMigrationWorker' }.size Sidekiq::ScheduledSet.new.select { |r| r.klass == 'BackgroundMigrationWorker' }.size
``` ```
### Batched background migrations
Batched background migrations need to finish before you update to a newer version.
Read more about [batched background migrations](../user/admin_area/monitoring/background_migrations.md).
### What do I do if my background migrations are stuck? ### What do I do if my background migrations are stuck?
WARNING: WARNING:
......
...@@ -23,13 +23,8 @@ prevent integer overflow for some tables. ...@@ -23,13 +23,8 @@ prevent integer overflow for some tables.
## Check the status of background migrations **(FREE SELF)** ## Check the status of background migrations **(FREE SELF)**
All migrations must have a `Finished` status before updating GitLab. To check the status of the existing All migrations must have a `Finished` status before you [upgrade GitLab](../../../update/index.md).
migrations: You can [check the status of existing migrations](../../../update/index.md#checking-for-background-migrations-before-upgrading).
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Monitoring > Background Migrations**.
![queued batched background migrations table](img/batched_background_migrations_queued_v14_0.png)
## Enable or disable batched background migrations **(FREE SELF)** ## Enable or disable batched background migrations **(FREE SELF)**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment