ConfigHub - Management

License

Clear view on the health of your TrendMiner license.

Updating the license can be achieved by clicking the “Browse files” button to select a file from your file-system, and then clicking “Upload license”.

Note: Contact the TrendMiner Customer Success team for more information concerning your license.

Backup and restore

Backup

The TrendMiner Appliance automatically creates a backup before an update. However, we always advise to take a backup manually when changing important configuration such as the configuration of an external identity provider or doing an uninstall.

It is also advised to periodically create and download a backup manually in case major system failures render the system unusable.

With the "+ Create backup" link located at the top, a manual backup can be created. Backups that are created, are stored on the system until they are removed (available as "Delete backup" under the options menu of that backup). Backups can be downloaded with "Download backup" in the options menu of the backup.

Restore

To restore a backup, click ‘Restore backup'. Old backups can be uploaded to the TrendMiner Appliance by clicking the ‘Upload’ button having selected the backup to upload.

Note: In case SAML is configured as external IdP, the SAML settings will be overwritten when importing a backup from a different environment, e.g. importing from staging to production. Due to this, the SAML metadata will change, and the IdP will reject the authentication request. To avoid this, you need to manually backup the provider table of the tm_security database BEFORE restoring the backup from the other environment. After restoring the backup, this table needs to be manually imported into the database, and finally the tm-security service needs to be restarted. Follow the steps below to do so.

1. On the TrendMiner system, as root, run:
   mysqldump tm_security provider > tm_security-provider.sql
2. Now restore the backup from the other environment and wait for the restore to finish. Afterwards, as root, run:
   mysql tm_security < tm_security-provider.sql
3. Finally restart tm-security. This can be done via ConfigHub, or also on the TrendMiner system, by running as root:
   nomad stop --purge tm-security
   nomad run /mnt/data/fileserve/tm-security.prod.hcl

Note: Uploading a backup does not restore that backup immediately. To restore a backup, click ‘Restore backup’ in the options menu.

Note: The original backup date/time is not part of the backup itself. The date and time of the upload will be used to identify the backup.

Note: The time displayed for the backup is always server time.

Diagnostics

Diagnostics

When opening support tickets, extended logging information should be provided. Press the ‘Collect & export’ button in the Diagnostics section to download this.

Memory

The Memory menu option shows information on the appliance memory usage.

Disk usage

After a fresh TrendMiner install, the disk space needs to be extended via ConfigHub because TrendMiner does not block the needed disk space by default in the beginning. Please check out minimal system requirements for the exact disk space which needs to be reserved.

Once the first disk is filled up completely. The original disk can never be extended because TrendMiner cannot change the partition table of the disk containing the root filesystem. A second virtual disk needs to be added to the TrendMiner appliance first. After adding a second virtual disk, the disk space for TrendMiner can be extended via the 'Extend' button on the interface.

Note: This extend option is only available on appliances.

TrendMiner upgrade

The TrendMiner Appliance can be upgraded through ConfigHub. The majority of TrendMiner updates will be distributed this way. However, when large back-end changes have been done, updating may require a new appliance into which the old data is imported. Please check release notes and update guide before starting an upgrade.

Note: We highly recommend taking a backup before upgrading

Use the 'TrendMiner upgrade' section in ConfigHub to select an upgrade package from the file system. Click 'Upgrade system' to apply the upgrade.

To restore a previous version of the application, also use the upgrade functionality as this will replace the current TrendMiner version with the one contained in the update archive. If a previously working TrendMiner version fails to function, this is most likely caused by an incompatibility in the data formats. Restore an old backup to resolve this issue.

Under the options menu on the top right an "Uninstall" option is available. This uninstall will remove all services except the ConfigHub service and allows the performance of a downgrade.

Note: We advise never to do a downgrade without contacting our support at support@trendminer.com as sometimes ConfigHub itself will not downgrade and might be incompatible with other downgraded services.

Note: Always create and download a backup of your installation before performing an uninstall.