Documentation

gitHub

Data backup

The Model Hub persists state in its state in the database. Back it up regularly, and always take a backup before upgrading.

 

WhatWhereWhy it matters
SQL databaseYour PostgreSQL or Oracle instanceStores models metadata, sync state, Git provider configuration, and other application data

 

Note

If you restore the database without the matching filestore (or vice versa), encrypted secrets in the database may become unreadable. Treat the database and filestore as a single backup set.

 

Backup your Model Hub database instance

Use your organization’s standard backup process for the database engine you chose at install time:

  • PostgreSQL 17+: managed snapshots, continuous backup, or pg_dump / pg_basebackup according to DBA standards
  • Oracle 26ai RMAN, managed backups, or your platform’s equivalent

 

Back up the Model Hub database (and schema) used by the application. Follow your DBA guidelines for consistency (for example, a snapshot that includes all tables owned by the Model Hub).

 

For a quick backup, you can also choose to just back up the tables git_repositories and kvs.

  • git_repositories contains the list of all Git repositories that contain your models.
  • kvs contains your configuration. Most importantly, the Git configuration and authentication.

 

With only these 2 tables, Model Hub will be able to reconstruct the rest by syncing your models from the configured Git providers, which remain the master single-source-of-truth.

 

Note

Prefer a normal full or incremental database backup over exporting individual tables. The Model Hub schema is maintained by the migration image; do not rely on “recreating the schema on restart” as a substitute for a proper backup and restore procedure.

 

When to back up

On a regular schedule that matches your recovery objectives (for example daily database backups)

  • Before every Model Hub upgrade (new MODEL_HUB_VERSION)
  • Before and after major changes to Git provider configuration or authentication
  • Before destructive maintenance on the database or host

 

Restore overview

1. Restore your Model Hub database to a consistent point in time.
2. Start Model Hub.
3. Confirm:

  • GET /health returns HTTP 200
  • The UI loads
  • Git provider configuration still works (or re-enter secrets if you intentionally rotated them)
  • Recent models are visible / sync still functions

 

You should document your restore runbook and test it periodically.