From a0d8344a33711e18ab80cf83a1a4c066ccf95606 Mon Sep 17 00:00:00 2001 From: Gabriel Mainberger Date: Mon, 12 Dec 2022 14:01:58 +0100 Subject: [PATCH 1/6] Upgrade from v10 to v11 --- .../pages/how-tos/upgrade-10.x-to-11.x.adoc | 33 +++++++++++++++++++ docs/modules/ROOT/pages/index.adoc | 10 +++--- docs/modules/ROOT/partials/nav.adoc | 1 + 3 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc new file mode 100644 index 00000000..fcefc18f --- /dev/null +++ b/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 at least a Kubernetes version of v1.21. +* K8up v1 support dropped. + +== Parameter changes + +* `charts.keycloakx` changed from `1.6.0` to `1.6.2`, the Keycloak image is updated from `18.0.2` to `19.0.3`. +* `charts.postgresql` changed from `11.6.15` to `12.1.0`, 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. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 960d3680..3741d9ec 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/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 with auto labels `kubernetes.io/metadata.name: `. ==== diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc index 94636295..380a4543 100644 --- a/docs/modules/ROOT/partials/nav.adoc +++ b/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] From 5f537353a051d45f898fba6e8e61cdb0ead68bc3 Mon Sep 17 00:00:00 2001 From: Megian Date: Mon, 12 Dec 2022 14:24:32 +0100 Subject: [PATCH 2/6] Apply suggestions from code review Co-authored-by: Simon Gerber --- docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc index fcefc18f..ddf92b96 100644 --- a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc +++ b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc @@ -4,8 +4,8 @@ This guide describes the steps to perform an upgrade of the component from versi == Changes -* The component requires at least a Kubernetes version of v1.21. -* K8up v1 support dropped. +* The component requires Kubernetes v1.21 or newer. +* K8up v1 support has been removed. == Parameter changes From f107bf39d285a1baea77c05ce3e274ba5ce584a6 Mon Sep 17 00:00:00 2001 From: Gabriel Mainberger Date: Mon, 12 Dec 2022 21:27:07 +0100 Subject: [PATCH 3/6] Update minimum version sentence --- docs/modules/ROOT/pages/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 3741d9ec..474ec3bb 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -7,5 +7,5 @@ The component defaults to provisioning a Bitnami Postgres database, but this beh [NOTE] ==== This component doesn't support Kubernetes versions older than 1.21 anymore. -This is because it assumes `Namespace` resources with auto labels `kubernetes.io/metadata.name: `. +This is because it assumes `Namespace` resources have an auto label `kubernetes.io/metadata.name: `. ==== From ffd94fa93fa143c903162a99110f9fd8b87179fa Mon Sep 17 00:00:00 2001 From: Gabriel Mainberger Date: Mon, 12 Dec 2022 22:48:18 +0100 Subject: [PATCH 4/6] Update charts.keycloakx and charts.postgresql version increase --- docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc index ddf92b96..18a601ec 100644 --- a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc +++ b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc @@ -4,13 +4,13 @@ This guide describes the steps to perform an upgrade of the component from versi == Changes -* The component requires Kubernetes v1.21 or newer. +* The component requires Kubernetes v1.21 or newer. * K8up v1 support has been removed. == Parameter changes -* `charts.keycloakx` changed from `1.6.0` to `1.6.2`, the Keycloak image is updated from `18.0.2` to `19.0.3`. -* `charts.postgresql` changed from `11.6.15` to `12.1.0`, the Postgresql version changes from version `11.14.0-debian-10-r28` to `postgresql:11.17.0-debian-11-r37`. +* `charts.keycloakx` changed from `1.6.1` to `1.6.2`, the Keycloak image is updated from `18.0.2` to `19.0.3`. +* `charts.postgresql` changed from `12.0.0` to `12.1.0`, 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. From 7b3474cd339598ede52196082f5964eb3e6a7e6c Mon Sep 17 00:00:00 2001 From: Gabriel Mainberger Date: Tue, 13 Dec 2022 11:17:10 +0100 Subject: [PATCH 5/6] Postgres helm chart upgrade v12.1.3 --- docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc index 18a601ec..0540ce32 100644 --- a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc +++ b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc @@ -10,7 +10,7 @@ This guide describes the steps to perform an upgrade of the component from versi == Parameter changes * `charts.keycloakx` changed from `1.6.1` to `1.6.2`, the Keycloak image is updated from `18.0.2` to `19.0.3`. -* `charts.postgresql` changed from `12.0.0` to `12.1.0`, the Postgresql version changes from version `11.14.0-debian-10-r28` to `postgresql:11.17.0-debian-11-r37`. +* `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. From 212dd37a2c7e5a13589533e0ca7388bbb599a85d Mon Sep 17 00:00:00 2001 From: Gabriel Mainberger Date: Tue, 13 Dec 2022 11:44:03 +0100 Subject: [PATCH 6/6] Update Keycloakx helm chart to v1.7.0 --- docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc index 0540ce32..f2b004e9 100644 --- a/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc +++ b/docs/modules/ROOT/pages/how-tos/upgrade-10.x-to-11.x.adoc @@ -9,7 +9,7 @@ This guide describes the steps to perform an upgrade of the component from versi == Parameter changes -* `charts.keycloakx` changed from `1.6.1` to `1.6.2`, the Keycloak image is updated from `18.0.2` to `19.0.3`. +* `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.