#Background

A coming update to SourceHut's internal design calls for the values of the ID columns in our databases to be made uniform. Each database (e.g. for git, hg, builds, etc) maintained its own copy of tables with shared information, sourcing updates from meta.sr.ht via webhooks, but each of these rows had an ID specific to each database. This change will make these IDs uniform across all services in preparation for linking our services more tightly together through GraphQL Federation.

This document outlines the extra steps required to perform this upgrade for third-party instances.

#Upgrade process

Ensure meta.sr.ht is running version 0.60.5 or later. Then, for each service, one at a time:

  1. Disable automatic migrations
  2. Shut off the service
  3. Run upgrades
  4. Run $service-migrate upgrade head (e.g. gitsrht-migrate) for each service and monitor the migration progress
  5. Turn on the service
  6. Re-enable automatic migrations if desired

Note: hub.sr.ht must be upgraded last, if present, and the other services must be running during its upgrade.

#git.sr.ht and hg.sr.ht

Both git.sr.ht and hg.sr.ht cache user IDs and usernames in Redis. Run the following command to clear the Redis cache after the services have been turned off and before they are turned on again:

redis-cli --scan --pattern "*.sr.ht.ssh-keys.*" | xargs redis-cli del
#pages.sr.ht

A special upgrade process is required for pages.sr.ht, which does not use the same system for database migrations as other services. Perform the same steps as described above, then run the scripts in contrib in the following order:

  • ./contrib/add_user_remote_id.py upgrade
  • ./contrib/use_canonical_user_id.py upgrade

To downgrade, repeat these commands in the reverse order with "downgrade".

#Downgrade process

For each service (excluding meta.sr.ht), one at a time:

  1. Shut off the service
  2. Run $service-migrate downgrade $version, selecting $version from the list below, for each service
  3. Downgrade the software
  4. Turn on the service
  5. Re-enable automatic migrations if desired
#Affected database schema revisions

Last schema revision prior to this change, for reference if downgrading:

  • builds.sr.ht: f79186791a25
  • git.sr.ht: 64fcd80183c8
  • hg.sr.ht: bb87b52896ac
  • hub.sr.ht: de4adc3cc306
  • lists.sr.ht: d4b5b0b5c3f6
  • man.sr.ht: 391282b09533
  • todo.sr.ht: e1e2e901be0c
  • meta.sr.ht: n/a
  • pages.sr.ht: n/a
#Additional resources

About this wiki

commit 5e3b25c91b85507d152f17800921ae9179516247
Author: Vlad-Stefan Harbuz <vlad@vladh.net>
Date:   2022-11-14T09:16:47+00:00

hacking: add examples for clarity

Signed-off-by: Vlad-Stefan Harbuz <vlad@vladh.net>
Clone this wiki
https://git.sr.ht/~sircmpwn/sr.ht-docs (read-only)
git@git.sr.ht:~sircmpwn/sr.ht-docs (read/write)