Skip to content

Upgrade instructions for v5.7.3

Overview⚓︎

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

Upgrading the cluster is fully automated for all production-scale Hydrolix clusters.

Use the special upgrade instructions only for clusters where

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

For most clusters, use the standard upgrade instructions in the v5.7.4 release notes.

Special upgrade instructions⚓︎

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

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

Outline of upgrade steps⚓︎

  1. Scale down keycloak
  2. Upgrade: Apply the new Hydrolix operator
  3. Scale up keycloak
  4. Monitor the upgrade process

Scale down Keycloak⚓︎

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
Use your preferred Kubernetes monitoring tool to confirm the `keycloak` pod terminates and does not restart.

### Apply the new Hydrolix operator

Apply the new operator directly with the `kubectl` command examples below.

#### GKE

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

EKS⚓︎

1
kubectl apply -f "https://www.hydrolix.io/operator/v5.7.3/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.7.3/operator-resources?namespace=${HDX_KUBERNETES_NAMESPACE}"

Scale up Keycloak⚓︎

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.

The init-turbine-api job depends on the new Keycloak to return the cluster to a healthy state.

Monitor the upgrade process⚓︎

If you need help, contact Hydrolix Support.