Qubership APIHUB — maintenance guide

Operators use this guide for backups, housekeeping, and pointers to the detailed administration pages. For the installation-time settings and the system token rotation, see the admin guide.

Data operations

Database backup & restore

Use stock PostgreSQL tools. Skip heavy/ephemeral Builder tables similar to backend recommendations.

Substitute APIHUB_DB_SERVER (hostname), APIHUB_DB_USER, APIHUB_DB_PASSWORD, APIHUB_DB_NAME with your Registry database (Compose sample: apihub_backend / apihub_backend_user, see scripts/init-db/init.sql). Perform parallel dumps for api_linter and agents_backend schemas if you operate those extensions.

pg_dump --no-owner --format=tar \
  --dbname="postgresql://${APIHUB_DB_USER}:${APIHUB_DB_PASSWORD}@${APIHUB_DB_SERVER}:5432/${APIHUB_DB_NAME}" \
  --file=./registry-dump.tar \
  --exclude-table-data=build \
  --exclude-table-data=build_src \
  --exclude-table-data=build_depends \
  --exclude-table-data=build_result \
  --exclude-table-data=builder_task \
  --exclude-table-data=builder_notifications \
  --exclude-schema=migration

pg_restore --no-owner \
  --dbname="postgresql://${APIHUB_DB_USER}:${APIHUB_DB_PASSWORD}@${APIHUB_DB_SERVER}:5432/${APIHUB_DB_NAME}" \
  ./registry-dump.tar

Destructive purge (labs only):

psql "postgresql://${APIHUB_DB_USER}:${APIHUB_DB_PASSWORD}@${APIHUB_DB_SERVER}:5432/${APIHUB_DB_NAME}" \
  -t -c "select 'drop table \"' || tablename || '\" cascade;' from pg_tables where schemaname = 'public'" \
  | psql "postgresql://${APIHUB_DB_USER}:${APIHUB_DB_PASSWORD}@${APIHUB_DB_SERVER}:5432/${APIHUB_DB_NAME}"

Data TTL & automated cleanup

Backend schedules (revisions/comparisons/soft-delete/unreferenced/builds) are declared in config.yaml cleanup block (see config.template.yaml). Behaviour + operational interpretation: data-maintenance.md. Snapshot retention for the Agents backend is in the admin guide.

Schema/internal migration analysis

When migrating stored specs between APIHUB versions, follow migration analysis procedure to read job logs responsibly.

Security

OIDC / SAML integration

Detailed protocol behaviours: security-model.md.

Access tokens lifecycle

This guide holds the backup procedure. Token handling has one operational home, the security checklist in the admin guide, which covers rotating the system token and the JWT signing key. The behavior of system and personal tokens is in the design item Access Tokens Management.

Personal access tokens

Design item: Manage Personal Access Tokens.

Package roles

Design item: Manage Roles.

Global settings surface

Design item: Version Validation (UI-side toggles complementing backend YAML).