Enterprise Server: Upgrade Docker on a VM
These are the upgrade instructions for pganalyze Enterprise Server running as a Docker (or podman) container on a VM.
Before proceeding, review the upgrade overview for the general process and any release-specific notes that may apply to your upgrade.
Upgrade steps
Step 1: Back up the statistics database
We recommend you make a backup of the pganalyze statistics database, to be able
to roll back an upgrade easily (see Recovering from a failed upgrade). You
don't need to save any other state besides the statistics database, and you can
use a simple pg_dump for backing up the database, or any other method that
allows a convenient restore (e.g. Amazon RDS snapshots).
Step 2: Pull the new pganalyze image
Log in to the pganalyze image registry:
docker login -e="." -u="pganalyze+enterprise_customer" -p="YOUR_PASSWORD" quay.ioPull the new version. Replace [new version] with the release you are upgrading to — check
the Releases page for the latest
version. The format of the version string is v2026.01.0 (year, month of release, minor updates).
docker pull quay.io/pganalyze/enterprise:[new version]Step 3: Stop the currently running container
docker stop pganalyze
docker rm pganalyzeStep 4: Run the database migration
Before starting the database migration task, make sure that the btree_gist and pgcrypto extensions are installed and available.
docker run --env-file /etc/pganalyze.env quay.io/pganalyze/enterprise:[new version] rake db:migrateThis will upgrade the database schema for the new release. At this point the database schema has been upgraded to the new version. Rolling back now requires restoring from the backup taken in Step 1.
If your upgrade requires release-specific environment variables (such as SKIP_PCO_BACKFILL),
set them in your /etc/pganalyze.env file before running the migration. See the
upgrade overview for release-specific notes.
Step 5: Run the Enterprise self-check
docker run --env-file /etc/pganalyze.env quay.io/pganalyze/enterprise:[new version] rake enterprise:self_checkIf this returns any errors, review your environment configuration in /etc/pganalyze.env.
Step 6: Start the container
docker run -d --name pganalyze -p 8080:5000 --env-file /etc/pganalyze.env quay.io/pganalyze/enterprise:[new version]At this point the upgrade is complete and the pganalyze UI should be accessible.
Recovering from a failed upgrade
Stop the pganalyze container if it is still running:
docker stop pganalyze
docker rm pganalyzeRestore the statistics database from the backup taken in Step 1. On Amazon RDS you
might choose to recover from a snapshot; on other systems you would usually use
pg_restore from a pg_dump you have done before.
After the backup is restored, start up the container with the old version:
docker run -d --name pganalyze -p 8080:5000 --env-file /etc/pganalyze.env quay.io/pganalyze/enterprise:[old version]Confirm the pganalyze UI is accessible and healthy before investigating what went wrong with the upgrade.
Couldn't find what you were looking for or want to talk about something specific?
Start a conversation with us →