Upgrade and Rollback
Upgrade to a new Hivel version or roll back to a previous version
Upgrade to a new Hivel version
Step 1: Check for New Version
Hivel does not currently publish a public changelog or allow self-serve browsing of the ECR registry.
Do this first: Contact your Hivel representative or email support@hivel.ai to:
Confirm a new version is available
Obtain the new image tag
Learn what the release contains
Ask if the release includes a database migration
Step 2: Take a Fresh Backup
Before upgrading, take a fresh backup of the PostgreSQL database. See Backup and Restore.
Step 3: Stop Services
On the host, run:
./deploy.sh --stopStep 4: Pull New Image Tags
Application/Location: Host
Pull the new image tags for the target version from ECR using the instructions your Hivel contact provided.
Step 5: Redeploy
On the host, run:
Or, for a targeted redeploy of a specific service:
Step 6: Run Database Migration (if applicable)
If your Hivel contact indicates the release includes a new database migration, complete this step. Otherwise, skip to Step 7.
6a: Switch to Superuser Credentials
Update config/.env to use Phase 1 (superuser) credentials. See Environment Configuration.
Migration requires elevated privileges and will fail against application-user credentials. See Migration Failed in Troubleshooting.
6b: Run the Migration
On the host, run:
Wait for the migration to complete successfully.
6c: Switch Back to Application-User Credentials
Update config/.env back to Phase 2 (application-user) credentials before continuing.
Step 7: Restart Services
On the host, run:
Step 8: Verify the Upgrade
Application/Location: Host (via SSH)
Complete the validation checklist from Verification and Access to confirm the upgrade succeeded.
Rollback to Previous Version
If you need to revert to the previous image tag:
Application/Location: Host (via SSH)
Revert to the previous image tag using the steps above (Steps 3–8)
Important: If the upgrade included a database migration, redeploying the old image tag alone may not be sufficient. Flyway migrations are not easily reversible. You may need to restore the pre-upgrade backup. See Backup and Restore.
Contact Hivel support (support@hivel.ai) before attempting to roll back a release that included a migration.
Additional Considerations
./deploy.sh --update pulls new images, but a specific release may require additional steps beyond image pulling. Confirm with Hivel support at the time you perform the upgrade whether anything else applies to your release.
Last updated