Upgrading from 1.x to 1.7.0

Connectware 1.7.0 affects the backward compatibility of the Connectware broker. Older broker data volumes are not compatible with brokers of Connectware 1.7.0 and newer. Upgrading to Connectware 1.7.0 requires additional upgrade procedures.

Additionally, multi-factor authentication (MFA) is now controlled via a dedicated configuration switch.

Important Notes

This upgrade will delete all persisted data of the Connectware broker. This includes client sessions, subscriptions, and retained data. If your configuration relies on any type of data persisted by the broker, make sure to properly initialize your applications after the upgrade.

If you rely on persisted data, create a backup or snapshot of the broker data volumes. This allows you to roll back in case of complications.

Upgrading Connectware

Depending on your Connectware installation, follow the Kubernetes or the Docker upgrade guide.

Kubernetes Upgrade Guide

1. Important: If your Connectware installation is below 1.5.0, make sure that you have followed Upgrade Connectware from 1.x to 1.5 (Kubernetes Guide) before upgrading to 1.7.0.

2. Scale down the broker cluster in Kubernetes. Set the number of broker nodes and control-plane-broker nodes to zero and wait until all broker pods have been successfully removed.

3. Delete the broker and control-plane-broker data volumes. Log volumes do not have to be deleted.

4. If you are using multi-factor authentication (MFA), set the Helm value global.authentication.mfa.enabled to true.

5. Apply the updated Helm Chart of Connectware version 1.7.0 For more information, see Installing Connectware on Kubernetes.

Once all pods are up and running again and no new deviations appear in Connectware, the upgrade has been successful.

Docker Upgrade Guide

1. Important: If your Connectware installation is below 1.5.0, make sure that you have followed Upgrade Connectware from 1.x to 1.5 (Docker Guide) before upgrading to 1.7.0.

2. To stop Connectware, go to the Connectware installation directory (default: /opt/connectware) and run docker compose down.

3. Delete the broker data volume of Connectware. Find the broker data volume in the list of volumes with docker volume ls and delete it with docker volume rm <connectware_brokerData>.

4. If you are using multi-factor authentication (MFA), set the environment variable CYBUS_MFA_ENABLED to true inside your .env file.

5. Download and install the new Connectware version. For more information, see Connectware installation guide.