Upgrading Connectware to 2.0.1 (Kubernetes)

How to upgrade Connectware to version 2.0.1 on Kubernetes.

Connectware 2.0.1 introduces enhancements to the Data Explorer.

If you are using services configured with CYBUS_MQTT_ROOT, you must run a migration script after installing Connectware 2.0.1 to ensure full Data Explorer compatibility.

If you are not using CYBUS_MQTT_ROOT, you can upgrade as usual — just note the additional hardware requirements.

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

Hardware Requirements

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

  • 400m CPU (0.4 CPU)

  • 1500 MiB of memory

On Kubernetes, this service runs with two replicas by default, effectively doubling the resource usage compared to Docker, but providing redundancy. Ensure your cluster has sufficient spare capacity before upgrading.

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

Upgrading Connectware to 2.0.1

Result: Connectware is upgraded to 2.0.1.

If you are using services configured with CYBUS_MQTT_ROOT, continue with step 2.

If you are not using CYBUS_MQTT_ROOT, your Connectware upgrade to 2.0.1 is complete. Just note the additional hardware requirements.

2

Migrating Services with CYBUS_MQTT_ROOT Configuration

If you are using services configured with CYBUS_MQTT_ROOT, you must run a migration script after installing Connectware 2.0.1 to ensure full Data Explorer compatibility.

  1. Set the shell variable ${YOUR_CONNECTWARE_NAMESPACE} to the Kubernetes namespace in which your Connectware is installed.

  2. Run the migration script. This is required if you have services using CYBUS_MQTT_ROOT.

kubectl debug -it \
  -n ${YOUR_CONNECTWARE_NAMESPACE} $(kubectl get pod -n ${YOUR_CONNECTWARE_NAMESPACE} -lapp=system-control-server -o name) \
 --image=registry.cybus.io/cybus/connectware-toolkit:1.3.0 \
 --target=system-control-server --profile general \
 -- bash -c 'cw-db-migrate-2_0_1'
  1. Verify that the script ran without errors.

  2. Restart the topic-explorer Deployment:

kubectl rollout restart -n ${YOUR_CONNECTWARE_NAMESPACE} deployment topic-explorer

Result: The migration script updates the database with new column values. You do not need to reinstall your services.

Last updated

Was this helpful?