Skip to content
Oriel

Migrations And Upgrades

Prerequisites

Section titled “Prerequisites”
  • Backup plan for PostgreSQL metadata and ClickHouse telemetry
  • New Oriel binary available
  • Same config file that the service uses

Steps

Section titled “Steps”

Check migration state:

Terminal window
oriel --config /etc/oriel/oriel.toml migrate status

Apply pending migrations:

Terminal window
oriel --config /etc/oriel/oriel.toml migrate up

Target one store when needed:

Terminal window
oriel --config /etc/oriel/oriel.toml migrate up --store metadata
oriel --config /etc/oriel/oriel.toml migrate up --store clickhouse

Systemd deployments run oriel-migrate.service before oriel.service.

Verify

Section titled “Verify”
Terminal window
oriel --config /etc/oriel/oriel.toml doctor
curl -fsS http://localhost:6743/readyz

Readiness fails with ORL-5002 when a node is serving against an incompatible schema.

Rollback/Recover

Section titled “Rollback/Recover”

Down migrations exist but destroy data and require --yes:

Terminal window
oriel --config /etc/oriel/oriel.toml migrate down --steps 1 --yes

Use down migrations only with a deliberate restore plan. Prefer restoring from database backups when an upgrade needs to be reverted.