Upgrading Connectware to 1.7.0 (Docker)

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.

Disclaimer

Some Connectware upgrades require you to follow a few additional steps when upgrading Connectware to a newer version.

When upgrading your Connectware instance, follow the required upgrade path based on your current version:

• If you are running Connectware version 1.4.1 or below:

  1. First upgrade to version 1.5.0

  2. Then upgrade to version 1.7.0

  3. Finally upgrade to version 2.0.0

• If you are running Connectware version between 1.5.0 and 1.6.2:

  1. First upgrade to version 1.7.0

  2. Then upgrade to version 2.0.0

• If you are running Connectware version 1.7.0 or later:

  • You can directly upgrade to version 2.0.0

For detailed instructions on each upgrade step, refer to:

• Upgrading Connectware to 2.0.0 (Docker)

• Upgrading Connectware to 1.7.0 (Docker)

• Upgrading from Connectware 1.x to 1.5.0 (Docker)

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 Procedure

1. Important: If your Connectware installation is below 1.5.0, make sure that you have followed Upgrading from 1.x to 1.5.0 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 Upgrading Connectware (Docker).