Skip to content

Downgrade instructions from v5.7.3

Overview⚓︎

The v5.7.x release included an upgrade to Keycloak v26.3.0.

Use the special downgrade procedure only for deployments where

  • Keycloak runs on a single node
  • The Hydrolix operator is prohibited from running multiple Keycloak pods on that node

For all other clusters, use the standard downgrade procedure, v5.7.3 to v5.6.2.

Standard downgrade procedure, v5.7.3 to v5.6.2⚓︎

Outline⚓︎

  1. Perform the schema migration rollback
  2. Perform the downgrade to v5.6.2

Perform the schema migration rollback⚓︎

Perform the standard downgrade to v5.6.2⚓︎

The below instructions are the same as the upgrade instructions from the v5.6.2 release notes.

If you have a self-managed installation, apply the new operator directly with the kubectl command examples below. If you're using Hydrolix-supplied tools to manage your installation, follow the procedure prescribed by those tools.

GKE⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}&gcp-storage-sa=${GCP_STORAGE_SA}"

EKS⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}&aws-storage-role=${AWS_STORAGE_ROLE}"

LKE and AKS⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}"

Monitor the standard downgrade process to v5.6.2⚓︎

Special downgrade procedure v5.7.3 to v5.6.2⚓︎

Use these instructions only for single-node clusters where operator is configured to forbid multiple Keycloak pods. This deployment configuration is not unusual for development clusters.

During this downgrade process, the cluster will not be fully usable.

Outline of downgrade steps⚓︎

  1. Execute the schema migration rollback
  2. Scale down keycloak
  3. Upgrade: Apply the new Hydrolix operator
  4. Scale up keycloak
  5. Monitor the downgrade process

Execute the schema migration rollback⚓︎

Scale down Keycloak (downgrade)⚓︎

Stop the Keycloak pods.

```bash Scale keycloak down to 0 kubectl scale deployment -n "${HDX_KUBERNETES_NAMESPACE}" keycloak --replicas=0 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
Use your preferred Kubernetes monitoring tool to confirm the `keycloak` pod terminates and does not restart.

### Perform the downgrade to v5.6.2

The below instructions are the same as the [upgrade instructions from the v5.6.2 release notes](../../release-notes/v5.6.2.md).

If you have a self-managed installation, apply the new operator directly with the `kubectl` command examples below. If you're using Hydrolix-supplied tools to manage your installation, follow the procedure prescribed by those tools.

#### GKE

```bash
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}&gcp-storage-sa=${GCP_STORAGE_SA}"

EKS⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}&aws-storage-role=${AWS_STORAGE_ROLE}"

LKE and AKS⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.6.2/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}"

Scale up Keycloak (downgrade)⚓︎

Scale Keycloak back up. Replace the replica count with your desired number of pods. If you are using these instructions, it was probably 1.

1
kubectl scale deployment -n "${HDX_KUBERNETES_NAMESPACE}" keycloak --replicas=1

Use your preferred Kubernetes monitoring tool to observe that the keycloak pod restarts.

Monitor the downgrade process⚓︎

If you need help, contact Hydrolix Support.