Mindbreeze GmbH, A-4020 Linz, 2020.
All rights reserved. All hardware and software names are trade names and/or trademarks of their respective owners.
These documents are confidential. The delivery and presentation of these documents alone does not justify any rights whatsoever to our software, our services and service performance results or other protected rights. The disclosure, publication or reproduction is not permitted.
For reasons of easier legibility, gender differentiation has been dispensed with. In terms of equal treatment, appropriate terms apply to both sexes.
This document describes the most important aspects of backing up Mindbreeze InSpire configuration and index data.
The backup strategy should contain the following types of data and should be applied especially before installing product updates:
Mindbreeze InSpire regularly backs up:
All other data must be backed up manually.
If you want to create manual backups, you can read about this in the following documentation, depending on which Mindbreeze InSpire Generation you are using:
Automatically created backups are stored in /data/backups. The following sections provide details on restoring backups.
Please note that shell access is required to restore configuration data.
Stop the mesmaster service and run the following script:
/opt/mindbreeze/bin/import_managerconfig.sh <configuration directory>
The <configuration directory> refers to the automatically created backups in the /data/backups/mesconfig-backups/inspire_mesconfig-<date time> directory.
Automatically created index backups are stored under /data/backups/index-backups. To restore the indexes, copy the underlying /data/backups/index-backups folders (but only the contents of the current folder) to their original directory (typically /data/indices or /data/servicedata), for example:
cp -a /data/backups/index-backups/ms-file/current/* /data/indices/ms-file
Automatically created database backups are stored under /data/backups/telemetrydb-pgdump/<date> and contain the following files:
To restore the databases, first stop the services mesnode and apptelemetryserver. You can then restore the databases with pg_restore.
Since Mindbreeze InSpire version 20.1 the command line tool mesadmin supports the sub-command snapshot. This makes it possible to create and restore snapshots independently of Mindbreeze InSpire Generation (G6 / G7). This tool can therefore be used to migrate a Mindbreeze InSpire G6 appliance to a new Mindbreeze InSpire G7 appliance.
A snapshot created with mesadmin snapshot contains
Please make sure that you keep your snapshots safe, as they contain sensitive information!
Please also note that snapshots created on G6 can only be migrated to G7. Migration from G6 to G6, G7 to G7, or G7 to G6 is not supported.
The following subsections explain how you can first take a snapshot of your Mindbreeze InSpire G6 appliance and import it into your new Mindbreeze InSpire G7 appliance. Please also note that in certain cases manual intervention is necessary – details will be described later.
The migration process is as follows:
Note: If you have a primary system and a standby appliance in use, only perform the following steps on your G6 primary system.
Create a snapshot using the following command:
mesadmin snapshot create --output-file /data/g6-snapshot.tar g6-snapshot
Only the most important app.telemetry log pools are included in the snapshot by default (Client Service, Query Service, Prediction Service, Client Service Query Log). If you want to include all log pools, you can specify the --exportalltelemetrytables option. If you want to completely exclude the app.telemetry database from the snapshot, you can specify the --skiptelemetry option. If you don't want to decide which data to migrate until you apply the snapshot to your G7 appliance, you can choose to do so later. Information about all other options can be displayed by executing the following command:
mesadmin snapshot create --help
After you have taken the snapshot (mesadmin snapshot create ... ), the command line tool writes a log to the standard output. Please check with the help of the log whether the export contains all required data.
ATTENTION: If the export is not complete, errors are shown, but the snapshot file is always created. If the missing data is not relevant to you, you can also import this snapshot into your G7 appliance.
Please note that a snapshot created with mesadmin snapshot only contains the configuration and not the index data. After the migration, all indexes must be rebuilt on the Mindbreeze InSpire G7 appliance; plan sufficient time for this.
Note: If you have a primary system and a standby appliance in use, perform the following steps only on your G7 primary system.
To apply a snapshot of your G6 appliance to your new G7 appliance, you must first copy the snapshot from your G6 appliance (/data/g6-snapshot.tar) to your G7 appliance. It is important that the snapshot file is accessible from the inspire Docker container. The directory /var/data/default/data on the G7 host can be accessed from the inspire Docker container under the directory /data. For example, you can copy the g6-snapshot.tar file to /var/data/default/data/.
Then switch to bash in your G7 appliance.
Start bash in the inspire Docker container on your G7 appliance by executing the following command:
docker exec -it inspire bash
Then check whether the snapshot was copied correctly based on the file size:
ls -l /data/g6-snapshot.tar
If the snapshot was copied correctly, you can start the migration by running the following command:
mesadmin snapshot migrate /data/g6-snapshot.tar
For example, if you do not want to migrate the app.telemetry database, you can specify the --skiptelemetry option. Information about all other options can be displayed by executing the following command:
mesadmin snapshot migrate --help
To get your Mindbreeze InSpire G7 appliance fully operational, you only need to follow a few small steps:
In certain cases, manual intervention is necessary during migration. This can be due to various reasons:
If the host name of your new G7 appliance is different from the G6 appliance, you will need to make manual changes to your G7 appliance:
Some files may be located in a directory that is not included in the snapshot. You have the following options:
Here are some examples:
The can already be customized with Mindbreeze InSpire G6. Please note that with G7 the "title" in "resource.json" may not contain any special characters. It is also possible that you have . Please note that you may need to change this if the host name of your G7 appliance has changed. Otherwise, the menu items function after the migration as already on G6.
Since Spring Release 2018 HF3 (G7 only) Mindbreeze InSpire supports a role-based permission system to restrict access to certain menu items. If you choose this variant, additional features are available, such as the definition of submenu items. To switch to the role-based variant, the inspire Docker container must not contain the file data/resources/resource.json. Rename the file first before you delete it permanently and read the .
If you have a primary system and a standby appliance in use, you only need to migrate the primary system (create the snapshot on G6 and install it on G7).
In Mindbreeze InSpire G7 (since version 19.0) the configuration and operation of a primary system and a standby appliance has been simplified (see and ). Since this has fundamentally changed the configuration, you will need to make a few configuration changes.