Docker Compose
Upgrade an installation made with the docker-compose project
The v6 branch of the docker-compose project runs the image tag 6, which always points to the newest 6.x release. An upgrade pulls that image again and recreates the container. Everything that must persist is stored in the data folder and is preserved.
Before you upgrade
Prepare the upgrade so that you can go back if something goes wrong:
- Take a backup under Settings → Backups. The new release upgrades the database schema at its first start.
- Read the changelog for the releases between your version and the new one.
- Moving to a new major version? Follow Upgrading to v7 in the 7.x documentation first.
1. Pull the new image
Download the newest image of the tag in docker-compose.yml:
cd /srv/apps/ansibleforms-docker
sudo docker compose pull
cd /srv/apps/ansibleforms-docker
sudo podman-compose pull
2. Recreate the containers
Start the project again; the containers whose image changed are recreated:
sudo docker compose up -d
sudo podman-compose down
sudo podman-compose up -d
3. Check the upgrade
Follow the application log while it starts. The first start of a new release upgrades the database schema:
sudo docker compose logs -f app
sudo podman-compose logs -f app
In AnsibleForms, Help → About shows the version that is running, and Settings → Status shows the health of the database, the schema and the other systems AnsibleForms depends on.
Roll back
To go back to the previous release, pin its exact tag in docker-compose.yml, image: ghcr.io/ansibleforms/ansibleforms:<previous release>, and run step 2 again. If that release does not start on the upgraded database, restore the backup you took under Settings → Backups. Set the tag back to 6 to receive updates again.
VIDEO: How to upgrade AnsibleForms