Upgrading Connectware to 2.0.1 (Docker)

How to upgrade Connectware to version 2.0.1 on Docker.

Connectware 2.0.1 introduces enhancements to the Data Explorer. If you are running services that are configured with CYBUS_MQTT_ROOT, this upgrade requires you to run a migration script to populate missing database entries.

Disclaimer

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

• If you are on version 1.4.1 or below

  • Upgrade sequentially: 1.5.0 → 1.7.0 → 2.0.0 → 2.0.1

• If you are between version 1.5.0 and 1.6.2

  • Upgrade sequentially: 1.7.0 → 2.0.0 → 2.0.1

• If you are on version 1.7.0 or newer (but below 2.0.0)

  • Upgrade sequentially: 2.0.0 → 2.0.1

• If you are on version 2.0.0

  • Upgrade directly to 2.0.1

Detailed instructions on each upgrade step

• Upgrading Connectware to 2.0.0 (Docker)

• Upgrading Connectware to 1.7.0 (Docker)

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

Hardware Requirements

Connectware 2.0.1 adds a new microservice for MQTT topic exploration. As a result, Connectware requires the following additional resources:

• 200m CPU (0.2 CPU)

• 750 MiB of memory

As with any deployment, we recommend monitoring system performance and adjusting resources as needed.

Upgrading Procedure

If your installation is older than 2.0.0, first complete the upgrade to 2.0.0 before upgrading to 2.0.1.

1. To stop Connectware, go to the Connectware installation directory (default: /opt/connectware) and run the following command:

docker compose down

1. Download and install Connectware 2.0.1. For more information, see Upgrading Connectware (Docker).

2. Start Connectware with the following command:

docker compose up -d

1. Ensure, that only a single instance of Connectware is running in this Docker installation. If you run multiple installations on the same machine, identify the postgresql container belonging to this installation manually using docker ps and use its name as CW_POSTGRESQL_CONTAINER in the next step.

2. Run the migration script with the following command:

CW_POSTGRESQL_CONTAINER=$(docker container ls -q -f "label=io.cybus.connectware=core" -f "label=com.docker.compose.service=postgresql")
docker exec $CW_POSTGRESQL_CONTAINER ash -c '/app/scripts/migrate_to_2.0.1.sh'

Result: The script completes the database migration by filling in missing values for new columns. Reinstalling services is not necessary.