Merge pull request #191 from projectsyn/documentation-v19

Upgrade from v10 to v11

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

@@ -0,0 +1,33 @@
+= Upgrade from v10 to v11
+
+This guide describes the steps to perform an upgrade of the component from version v9 to v10.
+
+== Changes
+
+* The component requires Kubernetes v1.21 or newer.
+* K8up v1 support has been removed.
+
+== Parameter changes
+
+* `charts.keycloakx` changed from `1.6.1` to `1.7.0`, the Keycloak image is updated from `18.0.2` to `19.0.3`.
+* `charts.postgresql` changed from `12.0.0` to `12.1.3`, the Postgresql version changes from version `11.14.0-debian-10-r28` to `postgresql:11.17.0-debian-11-r37`.
+
+If you've configured custom values for any of those parameters, make sure to adjust your configurations when upgrading from component version v9 to v10.
+
+== 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/pages/index.adoc

@@ -1,13 +1,11 @@
 = keycloak: A Commodore component to manage Keycloak
 
-This component provides a set of tuned defaults and a simplified interface to deploy the https://artifacthub.io/packages/helm/codecentric/keycloak/18.1.1[Keycloak helm chart] on a Syn-enabled cluster.
+This component provides a set of tuned defaults and a simplified interface to deploy the https://artifacthub.io/packages/helm/codecentric/keycloakx[Keycloak helm chart] on a Syn-enabled cluster.
 
-The component defaults to provisioning a Bitnami Postgres database via the
-Keycloak helm chart, but this behavior can be overridden using the
-`keycloak.postgres` parameters exposed by the component.
+The component defaults to provisioning a Bitnami Postgres database, but this behavior can be overridden using the `keycloak.provider` parameter exposed by the component.
 
 [NOTE]
 ====
-This component doesn't support Kubernetes versions older than 1.14 anymore.
-This is because it generates `Ingress` resources with `apiVersion: networking.k8s.io/v1`.
+This component doesn't support Kubernetes versions older than 1.21 anymore.
+This is because it assumes `Namespace` resources have an auto label `kubernetes.io/metadata.name: <namespace>`.
 ====

docs/modules/ROOT/partials/nav.adoc

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