Skip to content

Draft: JiHu guidelines for database migrations (separate schema approach)

Andreas Brandl requested to merge ab/jihu-db-separate into master

Direct reading link: https://ab-jihu-db-separate.about.gitlab-review.app/handbook/ceo/chief-of-staff-team/jihu-support/jihu-database-change-process.html

Why is this change being made?

In order to facilitate upgrades between GitLab CE/EE editions and JiHu editions, we need to find a good strategy for database schema changes. There are two different proposals:

  1. Unified schema approach (!90048 (merged)): Upstream GitLab gets all JiHu database migrations, all editions have the same schema
  2. Separate schema approach (this proposal): Keep JiHu database migrations specific to JiHu, provide adjustments for edition changes from GitLab to JiHu

This describes the "keep the database schema the same across GitLab CE/EE and JiHu editions" approach.

Related issues:

Summary

This proposal implements a clear separation of concerns between GitLab and JiHu database migrations. In order to support edition changes from GitLab to JiHu editions, we may need to resolve conflicts in database migrations for each release of JiHu.

This reduces operational overhead on GitLab.com, too, as we would not see any JiHu-specific database objects (e.g. indexes) on GitLab.com (where they are absolutely not required).

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this change to the correct DRI(s)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR.
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Andreas Brandl

Merge request reports