Upgrades

New versions arrive as a new bundle tadbir-onprem-<version>.tar, installed offline like the first one. Upgrades are included until your license's maintenance end date (see Your license).

Before you start

• Plan a maintenance window: Tadbir is unavailable from the moment the upgrade stops it until the new version answers, usually a few minutes.
• Check free disk space: the upgrade copies the database first (du -sh /srv/tadbir/postgres shows its size).
• Optionally run a backup and copy it off the server (see Backups).

Upgrade

sha256sum tadbir-onprem-1.5.0.tar      # compare with the checksum from Oloom
tar -xf tadbir-onprem-1.5.0.tar
cd tadbir-onprem-1.5.0
sudo compose/onprem/upgrade.sh

What it does, in order:

1. Checks the new bundle's signature with the key of the installed version, so only a genuine Oloom release is accepted.
2. Checks your license: a version released after your maintenance end date is refused, with the dates in the message. Without an uploaded license, this check is skipped.
3. Checks there is enough disk for the database copy, then loads the new images (no download).
4. Stops Tadbir and copies the database, license and settings to DATA_ROOT/upgrade-snapshot/.
5. Starts the new version. Database changes apply automatically at this first start.
6. Waits until the application, sign-in, web interface and maps answer.

[tadbir] verifying checksums
[tadbir] loading images (no registry access)
[tadbir] stopping 1.4.2
[tadbir] starting 1.5.0
[tadbir] waiting for services (up to 15 min)
[tadbir] healthy
[tadbir] upgraded 1.4.2 -> 1.5.0. Snapshot kept in /srv/tadbir/upgrade-snapshot until the next upgrade; rollback.sh --yes returns to it (keep /opt/tadbir/releases/1.4.2 until then).

Automatic rollback

If the new version does not answer within 15 minutes, upgrade.sh puts everything back by itself: the previous version, its database copy, license and settings. It then reports the failure:

[tadbir] upgrade failed: restoring 1.4.2 and its data
[tadbir] waiting for services (up to 15 min)
[tadbir] healthy
[tadbir] ERROR: upgrade to 1.5.0 failed; 1.4.2 restored (logs: /opt/tadbir/releases/1.5.0/compose/onprem/compose.sh logs)

Run doctor.sh and send the result to Oloom support.

Going back later

If you find a problem after a successful upgrade, you can return to the version and data from just before the upgrade:

sudo /opt/tadbir/current/compose/onprem/rollback.sh --yes

Everything entered since the upgrade is lost (records, users, an uploaded license). Uploaded files are kept. Without --yes, the script only explains this and stops. Prefer contacting Oloom support first when the upgrade is more than a few hours old.

Database engine upgrades

Tadbir releases keep the same PostgreSQL major version (15). If a future release changes it, its release notes include the migration steps; upgrade.sh does not change the database engine version by itself.