Volumes

The most reliable way of creating a backup of all Connectware-related data is to backup all used Docker volumes completely. (This might not be possible due to unavailable root permissions, but is the most secure way of backup for all Connectware.) All volumes that have been defined from the docker-compose.yml file can be backed up, and if they are all restored on any docker environment, the Connectware installation is fully restored.

Service Commissioning File Volume

In order to back-up all service commissioning file data, the service-manager volume must be backed up.

(In versions up to 1.0.82, the protocol-mapper volume(s) were also containing service commissioning file data, but starting with 1.0.83, all this data is stored only within the service-manager volume and there is no longer any actively used protocol-mapper volume.)

Kubernetes

In a Kubernetes installation, the content of the persistent volume service-manager needs to be backed up. The name of the volume is starting with service-manager and may have certain suffixes. The way of creating a backup and restoring this depends on the storage providers that are used in a specific Kubernetes installation.

Docker-compose

In a docker-compose installation, the respective volume name is prepended by the docker-compose project name. This docker-compose project name is either given explicitly when running docker-compose e.g. using the -p option, or is taken from the current working directory, such as connectware. If the project name is connectware, the respective volume name is connectware_service-manager.

With the volume name given as e.g. connectware_service-manager, the actual storage location on a local harddisk can be looked up using the command docker volume inspect connectware_service-manager. In a default docker configuration, this is the local harddisk directory

  • /var/lib/docker/volumes/connectware_service-manager/_data

This directory must be backed up regularly, and restored if a restore operation is needed.

An example command (requiring root privileges) which creates a compressed backup file /tmp/connectware-volume-backup.tgz looks like this:

cd  /var/lib/docker/volumes; \
tar cvfz /tmp/connectware-volume-backup.tgz \
./connectware_service-manager/_data

To restore the volume data from the created backup file, use the following command:

cd  /var/lib/docker/volumes; \
rm -rf ./connectware_service-manager/_data/*; \
tar xvfz /tmp/connectware-volume-backup.tgz

Last updated

Logo

© Copyright 2024, Cybus GmbH