From e636c4d7e56ac7b217495d2767433aee5e6ea8b3 Mon Sep 17 00:00:00 2001 From: Simon Stumpe Date: Tue, 22 Jul 2025 15:30:00 +0200 Subject: [PATCH] Updated upgrade documentation --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ebc6b4d..9257a69 100644 --- a/README.md +++ b/README.md @@ -210,29 +210,36 @@ docker compose build --no-cache \ ## Upgrade + + ### Test +This is intended for testing the upgrades before rollout on prod. 1. Check if the backups are up to date: `docker compose run --rm restore-cli /usr/local/bin/restic snapshots` 2. Update `AUTHENTIK_TAG` to the desired tag in `env.test.template`. -3. Commit & push changes to the Repo. +3. Check the upstream `docker-compose.yml` file against ours for changes made in the configuration. Check the Postgresql and Redis docker tags. Minor revisions of Postgresql *should be fine*, check the changelogs for any issues and if none are present raise to the latest Minor version (e.g. 16.6 -> 16.9). Redis should be less problematic for upgrades, check nonetheless. 4. Run `diff --color='auto' env.test.template .env` to display the diff between `env.test.template` and `.env`. -5. Port the made changes to `.env`. +5. Port the changes made to `.env`. 6. `docker-compose-2.32.4 pull` 7. `docker-compose-2.32.4 down` 8. `docker-compose-2.32.4 up -d; docker-compose-2.32.4 logs -f` +9. Check the logs for any issues during during startup. Check if https://sso.test.base23.de is available and test the sso login (e.g https://vpn-test.base23.de/admin) +10. Apply changes for test to prod files (`docker-compose..yml`, `env..template`), commit & push changes to the Repo in a new branch and create a merge request in preparation for the prod upgrade ### Prod +It is expected that the Upgrade has already been performed and tested on https://sso.test.base23.de, and the changes have been merged into main +0. Perform the Upgrade on test first. 1. Check if the backups are up to date: `docker compose run --rm restore-cli /usr/local/bin/restic snapshots` -2. Update `AUTHENTIK_TAG` to the desired tag in `env.prod.template`. -3. Commit & push changes to the Repo. -4. Run `diff --color='auto' env.prod.template .env` to display the diff between -`env.prod.template` and `.env`. -5. Port the made changes to `.env`. -6. `docker compose pull` -7. `docker compose down` -8. `docker compose up -d; docker compose logs -f` +2. Perform a git pull +4. Run `diff --color='auto' env.prod.template .env` to display the diff between `env.prod.template` and `.env`. +5. Run `diff --color='auto' docker-compose.prod.yml docker-compose.yml` to display the diff between `docker-compose.prod.yml`and docker-compose.yml` +6. Port the changes made to `.env` and `docker-compose.yml` +7. `docker compose pull` +8. `docker compose down` +9. `docker compose up -d; docker compose logs -f` +10. Check the logs for any issues during during startup. Check if https://sso.base23.de is available and test the sso login (e.g https://vpn.base23.de/admin). ## Disaster recovery / restore