Skip to content

Add documentation for obsolete migrations

Michael Trainor requested to merge tmike-doc-obsolete-migration into master

What does this MR do?

Obsolete migrations can never run or be retried, as their migration code is removed. I thought it would be beneficial to explicitly mention this in the docs, to allow customers and GitLab team members to better understand this process and the circumstances where migrations can't be run.

We've seen a number of tickets where customers have had to re-index from scratch due to having pending migrations that have been removed/made obsolete. Documenting this may improve support interactions, or remove the need for support involvement altogether.

This is documenting what has already been added to the Elastic::MigrationObsolete module:

https://gitlab.com/gitlab-org/gitlab/-/blob/e1914b0063b6802b2be7174b5a197850fa62368f/ee/app/workers/concerns/elastic/migration_obsolete.rb#L6-8

Related issues

Author's checklist

If you are a GitLab team member and 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.

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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.
Edited by Michael Trainor

Merge request reports