This is a PostgreSQL Docker container that automatically upgrades your database.
It's whole purpose in life is to automatically detect the version of PostgreSQL used in the existing PostgreSQL data directory, and automatically upgrade it (if needed) to the required version of PostgreSQL.
After this, the PostgreSQL server starts and runs as per normal.
The reason this Docker container is needed, is because the official Docker PostgreSQL container has no ability to handle version upgrades, which leaves people to figure it out manually (not great): docker-library/postgres#37
This Docker container does an in-place upgrade of the database data, so if something goes wrong you are expected to already have backups you can restore from.
This container is on Docker Hub:
https://hub.docker.com/r/pgautoupgrade/pgautoupgrade
To always use the latest version of PostgreSQL, use
the tag latest:
pgautoupgrade/pgautoupgrade:latest
If you instead want to run a specific version of PostgreSQL then pick a matching tag on our Docker Hub. For example, to use PostgreSQL 15 you can use:
pgautoupgrade/pgautoupgrade:15-alpine3.8
To build the docker image, use:
$ ./build.sh
This will take a few minutes to create the "pgautoupgrade:latest" docker container, that you can use in your docker-compose.yml files.
There are (at present) two predefined er... "breakpoints" in the container. When you run the container with either of them, then the container will start up and keep running, but the docker-entrypoint script will pause at the chosen location.
This way, you can docker exec into the running container to
try things out, do development, testing, debugging, etc.
The before breakpoint stops just before the pg_upgrade
part of the script runs, so you can try alternative things
instead.
$ ./run.sh -e PGAUTO_DEVEL=before
The server breakpoint stops after the existing pg_upgrade
script has run, but before the PostgreSQL server starts. Useful
if you want to investigate the results of the upgrade prior to
PostgreSQL acting on them.
$ ./run.sh -e PGAUTO_DEVEL=server
To run the tests, use:
$ ./test.sh
The test script creates an initial PostgreSQL database for Redash using an older PG version, then starts Redash using the above "automatic updating" PostgreSQL container to update the database to the latest PostgreSQL version.
It then checks that the database files were indeed updated to the newest PostgreSQL release, and outputs an obvious SUCCESS/FAILURE message for that loop.
The test runs in a loop, testing (in sequence) PostgreSQL versions 9.5, 9.6, 10.x, 11.x, 12.x, 13.x, and 14.x.