feat!: new 20.x release

.env.sample

@@ -6,6 +6,7 @@ DOMAIN=keycloak.example.com
 LETS_ENCRYPT_ENV=production
 
 ADMIN_USERNAME=admin
+WELCOME_THEME=keycloak
 
 SECRET_DB_ROOT_PASSWORD_VERSION=v1
 SECRET_DB_PASSWORD_VERSION=v1

compose.yml

@@ -3,7 +3,9 @@ version: "3.8"
 
 services:
   app:
-    image: "jboss/keycloak:16.1.0"
+    image: "keycloak/keycloak:20.0.1"
+    entrypoint: >
+      bash -c "KC_DB_PASSWORD=\"$$(cat /run/secrets/db_password)\" /opt/keycloak/bin/kc.sh start"
     networks:
       - proxy
       - internal
@@ -11,14 +13,14 @@ services:
       - admin_password
       - db_password
     environment:
-      - DB_ADDR=db
+      - KC_DB=mariadb
-      - DB_DATABASE=keycloak
+      - KC_DB_URL_DATABASE=keycloak
-      - DB_PASSWORD_FILE=/run/secrets/db_password
+      - KC_DB_URL_HOST=db
-      - DB_USER=keycloak
+      - KC_HOSTNAME=${DOMAIN}
-      - DB_VENDOR=mariadb
+      - KC_PROXY=edge
-      - KEYCLOAK_PASSWORD_FILE=/run/secrets/admin_password
+      - KC_SPI_CONNECTIONS_JPA_LEGACY_MIGRATION_STRATEGY=update
-      - KEYCLOAK_USER=${ADMIN_USERNAME}
+      - KEYCLOAK_ADMIN=${ADMIN_USERNAME}
-      - PROXY_ADDRESS_FORWARDING=true
+      - KEYCLOAK_WELCOME_THEME=${WELCOME_THEME}
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8080"]
       interval: 30s
@@ -42,7 +44,7 @@ services:
         - "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
         - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
         - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
-        - "coop-cloud.${STACK_NAME}.version=4.0.0+16.1.0"
+        - "coop-cloud.${STACK_NAME}.version=5.0.0+20.0.1"
 
   db:
     image: "mariadb:10.6"
@@ -58,6 +60,12 @@ services:
       - "mariadb:/var/lib/mysql"
     networks:
       - internal
+    deploy:
+      labels:
+          backupbot.backup: "true"
+          backupbot.backup.pre-hook: 'mkdir -p /tmp/backup/ && mysqldump --single-transaction -u root -p"$$(cat /run/secrets/db_root_password)" keycloak > /tmp/backup/backup.sql'
+          backupbot.backup.post-hook: "rm -rf /tmp/backup"
+          backupbot.backup.path: "/tmp/backup/"
 
 networks:
   internal:

release/4.0.0+16.1.0

@@ -0,0 +1,12 @@
+This major release comes with a blog post about a CVE:
+
+    https://www.keycloak.org/2021/12/cve.html
+
+Not all versions are affected but they're suggesting that people upgrade soon.
+
+As per usual, this upgrade didn't go too smoothly and I ended up having to
+undeploy and deploy the new versions. The healtcheck kept failing on the new
+instance when trying to deploy alongside the existing old version. Idk, some
+docker weirdness.
+
+No app data errors discovered after upgrade.

release/5.0.0+20.0.1

@@ -0,0 +1,9 @@
+You'll need to remove `/auth/` from your app SSO URLs, e.g.
+
+    https://foo.example.com/auth/realms/foo/protocol/openid-connect/auth
+
+Would become:
+
+    https://foo.example.com/realms/foo/protocol/openid-connect/auth
+
+-- decentral1se @ Autonomic