Skip to content

Instructions to run pending background migrations

Harsh Chouraria requested to merge hchouraria-docs-rerun-background-migration-jobs-pending-state into master

What does this MR do?

This change adds commands to re-run all migrations found marked as pending and remaining stuck in such a state

It expands on an existing area of troubleshooting background migrations while specifically targeting the pending state situation instead of migration jobs that are scheduled but remain un-executed.

It also adds an upgrade note to version 13.6 section where a background migration was introduced with a bug in it that can cause it to show up as pending in all releases after it. This was only recently noticed after we introduced new commands that check for pending background migration jobs as part of checking background migrations prior to upgrades.

A fix for the 13.6 bug should be included in GitLab 14.9 onwards via !81879 (merged) and following the added instructions should help clear the migration.

Related issues

Several customer tickets, see growing list in ZenDesk search (internal): https://gitlab.zendesk.com/agent/search/1?type=ticket&q=%22Gitlab%3A%3ADatabase%3A%3ABackgroundMigrationJob.pending.count%22

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports