Skip to content

Commit

Permalink
Add upgrade how-to from v13 to v14
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Mainberger committed Feb 23, 2024
1 parent 29aabc2 commit 6d1e5fc
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/modules/ROOT/pages/how-tos/upgrade-13.x-to-14.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
= Upgrade from v13 to v14

This guide describes the steps to perform an upgrade of the component from version v13 to v14.

== Breaking Changes

* Without intervention - see below - the default relativ path of Keycloak changes from `/auth` to `/`!
New installations should follow the [default](https://www.keycloak.org/migration/migrating-to-quarkus), which is `/` since a while.

== Changes

* The component requires Kubernetes v1.24 or newer.
* Keycloak version is v22.0.5 by default.
* Keycloak does now [support IPv4 and IPv6](https://www.keycloak.org/server/configuration-production#_configure_keycloak_server_with_ipv4_or_ipv6) at the same time.

== Parameter changes

* `relativePath` has been added.

== 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_DATABASE" PGUSER="$POSTGRES_USER" PGPASSWORD="$POSTGRES_PASSWORD" pg_dump --clean' > keycloak-postgresql-$(date +%F-%H-%M-%S).sql
----

. If you want to preserve the relativ path of `/auth` please add:
+
[source,bash]
----
parameters:
<keycloak instance>:
relativePath: /auth
----

. Apply the parameter changes.

. Compile and push the cluster catalog.
1 change: 1 addition & 0 deletions docs/modules/ROOT/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* 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/upgrade-13.x-to-14.x.adoc[Upgrade 13.x to 14.x]
* xref:how-tos/openshift-4.adoc[Install on OpenShift 4]
* xref:how-tos/pin-versions.adoc[Pin versions]
Expand Down

0 comments on commit 6d1e5fc

Please sign in to comment.