Restore Unify from a backup
The restore endpoint begins restoring Tamr and returns an object with metadata describing the restore.
The POST body should be a string pointing to the location of your backup. Acceptable backup locations are S3, HDFS, or a local folder. If the backup is in S3, make sure to set your access credentials TAMR_UNIFY_BACKUP_AWS_ACCESS_KEY_ID and TAMR_UNIFY_BACKUP_AWS_SECRET_ACCESS_KEY before initiating the restore.
'hdfs://namenode1.hdfs.tamr:50071/my-backup/2018-05-17_23-26-55-201'
Upon successful initiation of a restore, the service returns an identifier representing the restore. You can use the identifier to look up the status of the restore via the Check Restore Status endpoint.
Response Fields
| Field | Description |
|---|---|
| id | The ID of the restore started. Unique across the entire deployment of Tamr. |
| type | The shortened ID of the restore. Use this for querying the status. |
| description | A description of the restore. |
| status | A JSON object, containing a field for start time. |
| created | A JSON object, containing a field for time created, and who created it. |
| relativeId | The relative ID of the restore started. |
Implementation
Restore puts Unify in a quiet state where only the restore process runs, most service endpoints are unavailable, and UI operations are unavailable.
Restore will read backup data from the location provided to the start restore service method. All backup locations, including S3 and HDFS, are valid sources.
Restore will update Unify with a subset of the service related configuration stored through the administrative utility (Additional Configuration Variables for Backup ).
Restoring Configuration
Note that any configurations not explicitly stored upon backup or included in the list of automatically backed up variables will be overwritten on restore. Any additional variables will need to be restored by hand, or added to the
TAMR_UNIFY_BACKUP_EXTRA_CONFIG_PROPSlist at the time of backup.
Unify becomes available once the restore is complete. If you attempt to use the UI during restore, there will be an error message reading: The system is temporarily in a read-only mode.
When the restore is complete, you must restart Unify and its dependencies to apply the new configuration (Restarting).