Version-Specific Upgrades (Docker)
Last updated
Was this helpful?
Last updated
Was this helpful?
The following Connectware upgrades require you to follow a few additional steps when upgrading Connectware to a newer version:
Upgrading from 1.x to 1.7.0
Upgrading from 1.x to 1.5.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.
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.
Important: If your Connectware installation is below 1.5.0, make sure that you have followed before upgrading to 1.7.0.
To stop Connectware, go to the Connectware installation directory (default: /opt/connectware
) and run docker compose down
.
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>
.
If you are using multi-factor authentication (MFA), set the environment variable CYBUS_MFA_ENABLED
to true
inside your .env file.
Download and install the new Connectware version. For more information, see .
This section describes the upgrade of a Cybus Connectware installation from a previous 1.x version to 1.5.0 and later.
The additional upgrade steps require you to use the docker-compose.override.yml
file. If you already use such a file in your Connectware installation directory make sure to create a backup of this file to later restore.
In Connectware 1.5.0, we’ve enhanced security by primarily using a system user with limited permissions, following the principle of using the least amount of privilege needed for our software components.
As a result, you’ll need to follow a few additional steps when updating to Connectware 1.5.0 or later.
The first part of this document covers updating Connectware, while the second part focuses on agents.
With the introduction of Connectware 1.5.0, which prefers to use a system user with limited privileges whenever possible, you’ll need to modify the permissions of your volumes. This ensures that the system user has the necessary write access to the existing volumes in your setup.
The following protocols may not operate as expected in some constellations:
If you experience problems with these protocols after upgrading to Connectware 1.5.0, these affected services may require root permissions and are no longer supported by the internal protocol-mapper or agents without root permissions.
In this case, you should transfer the service that uses these protocols to a separate agent. This agent can have higher permissions but in a controlled manner.
As an additional step for this upgrade, we offer a docker-compose.override.yml
file, which will help you adjusting volume permissions. The upgrade will consist of the following steps:
Shut down Connectware
Save the provided file as docker-compose.override.yml
in the same folder as your Connectware docker-compose.yml
Start the the Docker composition to adjust volume permissions
Remove the docker-compose.override.yml
file
Upgrade Connectware using the connectware-online-installer.sh
script
Run docker compose down
to remove the temporary permissions fix container. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly. Next, delete the file docker-compose.override.yml
. If you used a docker-compose.override.yml
in your installation before this update, restore your original file.
Download and run the Connectware online installer like for other updates:
Run the commands as you would usually do, be that as a regular user, using sudo
or as the user root
directly. After updating you can start Connectware as usual.
If you wish to verify that Connectware services run with an unprivileged user, you can optionally run this command:
Only the service container-manager
should be using the user ID 0
.
In case of any questions or trouble, feel free to contact Cybus Support.
In order to upgrade your agents, you need to decide between these two options:
Adjust volume permissions to allow the unprivileged system user to write data (recommended) OR
Adjust your docker composition to continue running with higher privileges
To benefit from the improvements to security, we recommend to adjust volume permissions over continuing to run with higher privileges.
If you are using HBM DAQ or OPC DA, you may need to follow the second option of continuing with higher privileges.
If you choose to adjust volume permissions, we offer a docker-compose.override.yml
which will help you adjusting volume permissions. The upgrade will consist of the following steps:
Shut down the agent
Save the provided file as docker-compose.override.yml
in the same folder as your agent’s docker-compose.yml
Start the the Docker composition to adjust volume permissions
Remove the docker-compose.override.yml
file
Upgrade the agent by adjusting the image tag in your docker-compose.yml
file
Use this file as docker-compose.override.yml
:
If you use a different name for your agent Docker service and volume than our example, you need to adjust the highlighted line to the name you use for your agent and its volume inside your docker-compose.yml
file.
If you already have a docker-compose.override.yml
file for your agent’s installation directory, make sure to rename it before storing this file as docker-compose.override.yml
.
Run docker compose down
to remove the temporary permissions fix container. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly. Next, delete the file docker-compose.override.yml
. If you used a docker-compose.override.yml
for your agent before this update, restore your original file.
Set the image tag used for the agent to the same tag that your current Connectware installation uses, but at least 1.5.0
. If you have not yet upgraded your Connectware to at least version 1.5.0
, please do so now.
Example:
You can now start your agent as usual, for example by running docker compose up -d
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly.
In case of any questions or trouble, feel free to contact Cybus Support.
If you have not yet upgraded your Connectware to at least version 1.5.0
, please do so first.
As an alternative to modifying volume permissions, or if you use a protocol that requires elevated permissions, you can modify your agent’s docker-compose.yml
file to specify the system user which is used for the container.
To do so, simply add user: root
to the docker compose service of your agent, while adjusting the image tag to the same tag that your current Connectware installation uses, but at least 1.5.0
, as highlighted in this example:
You can now start your agent as usual, for example by running docker compose up -d
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly.
If you use a docker run
command, you can simply add --user=root
to the command.
In case of any questions or trouble, feel free to contact Cybus Support.
To learn how to configure an agent to operate with root permissions, check out the section on .
Connectware agents are ideally orchestrated using Docker Compose as described in .