Upgrading from 1.x to 1.5.0
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.
To learn how to configure an agent to operate with root permissions, check out the section on agent orchestration.
Upgrading Connectware
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 Connectwaredocker-compose.yml
Start the the Docker composition to adjust volume permissions
Remove the
docker-compose.override.yml
fileUpgrade Connectware using the
connectware-online-installer.sh
script
1. Shut down Connectware
Within your installation folder, execute docker compose down
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly.
2. Download & save override file
Use this file as docker-compose.override.yml
:
Download:
If you already have a docker-compose.override.yml
file for your Connectware installation, make sure to rename it before storing this file as docker-compose.override.yml
.
3. Adjust volume permissions
Run docker compose up
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly. You should see output similar to this:
4. Remove override file
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.
5. Upgrade Connectware
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.
Upgrading Connectware agents
Connectware agents are ideally orchestrated using docker-compose as described in agent orchestration.
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.
Upgrading agents by adjusting volumes
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’sdocker-compose.yml
Start the the Docker composition to adjust volume permissions
Remove the
docker-compose.override.yml
fileUpgrade the agent by adjusting the image tag in your
docker-compose.yml
file
1. Shut down agent
Within your agent’s installation folder, execute docker compose down
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly.
2. Download & save override file
Use this file as docker-compose.override.yml
:
Download:
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
.
3. Adjust volume permissions
Run docker compose up
. Run the command as you would usually do, be that as a regular user, using sudo
or as the user root
directly. You should see output similar to this:
4. Remove override file
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.
5. Upgrade the agent
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.
Upgrading by using root privileges
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.
Last updated