Update Process for Docker

Updating the OPC Router from a version in the 5 series to the next higher version involves removing the container of the current version and subsequently redeploying a container of a new version. It is important to note that your project files and settings could be affected by this process depending on the container configuration unless data persistence is ensured beforehand.

1. Compatibility Check
   • Before updating on the production server, ensure that your current project setup is compatible with the new OPC Router version. This can be done through a preliminary test on a virtual machine. In most cases, the OPC Router automatically adjusts existing projects after an update if necessary.
   • Ensure that all system requirements for the new version of the OPC Router are met.
2. Preparation
   • Export your project to ensure that you can revert to the previous configuration in case of any issues.
   • Ensure that data is persisted in relevant paths to avoid losing project data, settings, license activations, or log files.

note

If no mappings were set up during the creation of the existing containers, all data will be lost when deleting the containers. 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 using the following command:
     docker rm containername
     If the container was created using Compose, it is recommended to remove the container again using docker compose down to ensure that no unused components remain.

warning

This step cannot be undone. Make sure to back up all data you intend to use in the new container beforehand.

4. Creating the container with the new version
   Download the desired new image using docker pull image:tag. Available images and tags can be found on our Docker Hub page.
   • Compose:
     • Adjust the value of the image field in the docker-compose.yml file to create a container with the desired version.
     • Modify environment variables, port mappings, and volume mappings according to the documentation if necessary.
     • Create and start the container using docker compose up.
   • Docker CLI:
     • Create and start the container using docker run <options> image:tag. The options to use depend on your specific 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 use, and no further actions are required. However, if you set up the container without transferring data, you can now use the demo, apply a license, create a new project, or import an existing project, and then put everything into production.