Merge pull request #225 from projectsyn/changelog-v12

Add upgrade how-to from v11 to v12

docs/modules/ROOT/pages/how-tos/upgrade-11.x-to-12.x.adoc

@@ -0,0 +1,32 @@
+= Upgrade from v11 to v12
+
+This guide describes the steps to perform an upgrade of the component from version v11 to v12.
+
+== Changes
+
+* Parameters for the chart source and version has been changed against https://syn.tools/syn/explanations/commodore-components/helm-charts.html#_example[Project Syn best practices].
+
+== Parameter changes
+
+* `charts.keycloakx` changed to `charts.keycloakx.version`.
+* `charts.postgresql` changed to `charts.postgresql.version`.
+
+If you've configured custom values for any of those parameters, make sure to adjust your configurations when upgrading from component version v11 to v12.
+
+== 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.

docs/modules/ROOT/partials/nav.adoc

@@ -23,6 +23,7 @@
 * xref:how-tos/upgrade-8.x-to-9.x.adoc[Upgrade 8.x to 9.x]
 * 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/openshift-4.adoc[Install on OpenShift 4]
 * xref:how-tos/pin-versions.adoc[Pin versions]