Update process for Docker

Updating the OPC Router from a version in the 5 series to the next higher version involves removing a container of the current version and then redeploying a container of a new version. Please note that depending on the configuration of the container, your project files and settings may be affected by this process if data persistence is not ensured beforehand.

1. Compatibility check

• Before updating the production server, ensure that your current project configuration is compatible with the new OPC Router version. This can be done by performing a preliminary test on a virtual machine. In most cases, the OPC Router automatically adapts existing projects after an update, if necessary.
• Ensure that all system requirements for the new version of OPC Router are met.

2. Preparation

• Export your project to ensure that you can revert to the previous configuration in case of a problem.
• Ensure that data is persisted in relevant paths so that no project data, settings, license activations, or log files are lost.

note

If no mappings were set up when the existing container was created, all data will be lost when the container is deleted. To manually back up data from the container, you can use the following command for all relevant paths:
docker cp containername:/path/in/container /path/in/dockerhost

3. Removing the container with the old version

• The existing container can be removed with the following command:
  docker rm containername
  If the container was created with Compose, it is recommended to remove the container again with docker compose down so that no unused components remain.

warning

This step cannot be undone. Make sure that all data you want to use in the new container is backed up beforehand.

4. Creating the container with the new version

• Download the desired new image with docker pull image:tag. Available images and tags can be found on our Dockerhub page.
• Compose
  • Adjust the value of the image field in docker-compose.yml to create a container in the desired version.
  • If necessary, adjust environment variables, port mappings and volume mappings according to the documentation.
  • Create and start the container with docker compose up
• Docker CLI
  • Create and start the container with docker run <optionen> image:tag
    The options to be used vary depending on your individual use case and can be found in the documentation.

5. Finalization

• If you have transferred data from your previous container, the container is now ready for operation and no further action is necessary. However, if you have set up the container without transferring any data, you can now use the demo or import a license, create a new project or import an existing project, and then put everything into production.