Merge pull request #238 from projectsyn/upgrade-v13

Add upgrade how-to from v12 to v13
projectsyn · Sep 18, 2023 · c422e2f · c422e2f
2 parents 4924222 + 0b91d1d
commit c422e2f
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-12.x-to-13.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-12.x-to-13.x.adoc
@@ -0,0 +1,26 @@
+= Upgrade from v12 to v13
+
+This guide describes the steps to perform an upgrade of the component from version v12 to v13.
+
+== Changes
+
+* The component requires Kubernetes v1.23 or newer.
+* Keycloak version is v21.1.2 by default.
+
+== Step-by-step guide
+
+When upgrading the component, the following actions are required if the built-in database is used:
+
+. Do a backup of the built-in database.
++
+[source,bash]
+----
+instance=keycloak
+namespace=syn-${instance}
+
+kubectl -n "${namespace}" exec -ti keycloak-postgresql-0 -c postgresql -- sh -c 'PGDATABASE="$POSTGRES_DB" PGUSER="$POSTGRES_USER" PGPASSWORD="$POSTGRES_PASSWORD" pg_dump --clean' > keycloak-postgresql-$(date +%F-%H-%M-%S).sql
+----
+
+. Apply the parameter changes.
+
+. Compile and push the cluster catalog.
diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc
@@ -24,6 +24,7 @@
 * xref:how-tos/upgrade-9.x-to-10.x.adoc[Upgrade 9.x to 10.x]
 * xref:how-tos/upgrade-10.x-to-11.x.adoc[Upgrade 10.x to 11.x]
 * xref:how-tos/upgrade-11.x-to-12.x.adoc[Upgrade 11.x to 12.x]
+* xref:how-tos/upgrade-12.x-to-13.x.adoc[Upgrade 12.x to 13.x]
 * xref:how-tos/openshift-4.adoc[Install on OpenShift 4]
 * xref:how-tos/pin-versions.adoc[Pin versions]