HomeTamr Core GuidesTamr Core API Reference
Tamr Core GuidesTamr Core API ReferenceTamr Core TutorialsEnrichment API ReferenceSupport Help CenterLog In

Restore

Steps to restore a single-node on-premises Tamr Core deployment from a target instance to the destination instance.

Target instance: The instance from which you are restoring from backup.
Destination instance: The instance on which you are restoring from backup.

importantimportant Important: Do not try to use a server snapshot as a substitute for a Tamr Core application backup. Server snapshots do not provide the correct backups of Tamr Core configuration during a restore. In addition, if Tamr Core is running when you take a server snapshot a corrupt HBase configuration can result if you restore from the snapshot. Instead, take Tamr Core application backups before introducing any changes.

Before You Begin:

  • Verify that you have an existing Tamr Core installation running identical major and minor version. See Installation. The patch version does not need to match exactly. For information about patches, see Upgrading Tamr Core.
  • Verify that you have a backup file created on the target instance. See Backup and backups (v1).
  • Verify that the location of the backup files needs to be in a place from which the destination instance can read them, and inside of the TAMR_UNIFY_BACKUP_URI for the destination instance.
  • Verify that the Tamr Core functional user, such as tamr, has read and write permissions on the TAMR_UNIFY_BACKUP_URI for the destination instance.
  • Verify that the destination instance contains a clean Tamr Core installation. For more information, consult the Tamr Help Center.

Notes:

  • During the restore operation, Tamr Core is in a read-only state; no other user actions or changes can be performed.
  • Restoring Tamr Core from a backup deletes all data in the destination instance and automatically restarts Tamr Core.
  • Restoring Tamr Core from a backup resets the password for the "system" user to its default value. Be sure to follow the additional steps required for changing the password of the "system" user. See Editing User Passwords. The "admin" password is restored.

Restoring from a Backup

Before you begin, ensure that you have met the requirements listed above.

To restore an instance from a backup

Restore Tamr Core from a backup and wait for its completion by polling for a status of the restore operation.Restore Tamr Core from a backup and wait for its completion by polling for a status of the restore operation.

Restore Tamr Core from a backup and wait for its completion by polling for a status of the restore operation.

  1. On the destination instance, restore Tamr Core from a backup by reading a backup specified in the POST body. Run:
    POST /v1/instance/restore
    Tamr Core is unavailable during a restore process. See backups (v1).
  2. Poll for the status of the restore operation until status.state=SUCCEEDED is returned. Run:
    GET /v1/instance/restore. Also see instances (v1).
  3. Change the password for the "system" user. See Editing User Passwords.

Restoring from Backup on Another Instance

Once you create a backup on the target instance and then restore from it on one destination instance, you can also restore from the same backup files on another destination instance. Two situations are possible and they depend on the location in which the backup files are stored.

  • If you are using a distributed filesystem to store the backup files, you can restore from the backup to any destination instance without having to physically transfer backup files.
  • If you are using a server filesystem, create a TAR of the backup so you only have to transfer one file, copy this backup file to the destination instance inside of the TAMR_UNIFY_BACKUP_URI, extract the TAR file to the correct location, and trigger a restore process. For details, see Restore.

Did this page help you?