In this section, we describe how to restore a backup that was created in the same Collibra Data Intelligence Platform version as your current version. You can restore backups to recover from data corruption or to transfer your data to another environment.
- When you create a backup, you have the option to include data, meaning all of the data in your Collibra environment related to communities, domains, assets, users, operating models and so on. When you restore a backup that includes data, all new data in your environment that was imported or otherwise created after the backup was created is irrevocably lost.
- You cannot restore a backup that is created from a newer Collibra version, on an older Collibra environment. For example, if you have a backup that is created on a 5.9 environment, you cannot restore this backup on 5.8 or older. You can, however, restore a an older version in a newer environment, for example a 5.8 backup in an 5.9 environment.
- Backups from versions older than 5.5.x do no include certificates. You have to reinstall any necessary certificates, for example for secure communication with the Jobserver.
- If you restore a backup that does not include history and was made from a version older than 5.7.x, the data quality metrics will not work correctly. To solve this issue, after you restore the backup in your latest environment, upgrade the data, create a new backup and restore the new backup in the same environment.
- If the Collibra environment you want to restore has one or more Edge sites, you need to reinstall all of them. To reinstall one or more Edge sites, go to Reinstall an Edge site.
Steps
You can restore a backup via the backups page or via your environment overview page:
- Open Collibra Console with a user profile that has at least the ADMIN role.
Collibra Console opens with the Infrastructure page. -
In the main menu, click Backups.
The backups page appears. - Click
Restore in the row of the backup that you want to restore. - Click the name of an environment to show its details.
- Click More → Restore from backup
- Fill in the Restore from backup form:
Option Description Environment Select the environment in which you want to restore the backup. Backup Select the backup that you want to restore. Include You can restore a backup fully or partially.
Note The backup itself should include the items you select below. For example, if the backup does not contain the configuration and you include configuration for restoring the backup, it will be restored successfully, though without the configuration.
Data Select to include the core (database) data from the backup. This is all the data related to communities, domains, assets, users, operating model and so on. History Select to include all historic data (activity and snapshot-related) from the backup. Configuration Select to include the configuration and license from the backup.
Warning Do not select this option if you restore a backup from another environment, as this will overwrite the configuration of your current environment. It can prevent your environment from starting up again.
Customizations Select to include custom modules, styling, page-definitions and email template files.
This will add files to the Collibra user home directory and files that are used to customize the Collibra DGC instance (/opt/collibra_data/console/config). This concerns all the files in the following directories:
- email-templates
- groovy-lib
- images
- page-definitions
- security
- styling
- translations
- modules (if available)
- Click Restore backup.
The backup is restored on the selected environment. The time to restore a backup depends heavily on the amount of data that the backup contains. During the restore time, your environment is unavailable.
The restore process is completed when all services of your environment have again the running status.
What's next?
If the configuration file is restored, the database connection information in the backup is ignored. In other words, the restore process makes sure that the entire backed-up configuration is applied to the current configuration without modifying the current database connection. This means that the existing database connection is used to restore the data. Also, after the restore, the Collibra instance continues to use the same database connection.
- You cannot restore a backup from a Collibra environment that is using a database with a case-sensitive collation sequence into a Collibra environment that is using a database with a collation sequence that is not case-sensitive. If you want to use backup and restore to migrate Collibra content, ask your database administrator to determine whether the collation sequences of the databases used by your source and target Collibra environments are compatible.
- If you restore a backup without the history, Collibra does not restore the activity stream as it was. Instead, it creates the entries in the activity stream as if they were done by the System User on the restore date.