This section details how to create a backup of the Metastore prior to an upgrade.
Internal vs. external Metastore
When you create a backup of the Metastore, it's important to consider whether your deployment of Collibra DQ uses the internal Metastore located on the same server as your Collibra DQ application, or an external metastore separate from the Collibra DQ server. While most Cloud Native and Standalone deployments of Collibra DQ use an external Metastore, such as GCP Cloud SQL or AWS RDS, some Standalone deployments use an internal Metastore. Regardless of your Metastore setup, it's imperative you have a backup copy of Collibra DQ that you can restore if needed.
Backup and restore
- Internal
- External
Create a backup
To create a snapshot of an internal Metastore, copy the contents within the owl/postgres folder created during the installation.
Restore a backup
To restore a snapshot of an internal Metastore, replace the contents of the owl/postgres folder created during installation with the owl/postgres folder you copied when you created the backup.
Create a backup
External Metastores are the most commonly used Metastores for both Cloud Native and Standalone deployments of Collibra DQ. Because the procedure for backing up external Metastores varies from one environment setup to the next, there are no formal steps for this process. However, we strongly recommend referring to the official PostgreSQL documentation for information about backing up PostgreSQL Metastores.
If your organization has modified the Collibra DQ Helm Charts for a Cloud Native deployment, including the creation of custom Kubernetes objects either inside or outside of the Helm Charts provided to you by Collibra, you need to create a backup of your Metastore before upgrading to a new version of Collibra DQ. The purpose of this is to ensure that the definitions of the custom Kubernetes objects are preserved and that you can recreate them, as necessary.
Important Any custom changes made to Kubernetes objects, whether inside or outside Collibra-provided Helm Charts, are the responsibility of your organization.
If your organization uses the Helm Command and Helm Chart provided by Collibra to complete the end-to-end upgrade and deployment of new versions of Collibra DQ and have not created custom Kubernetes objects, we still recommend creating a backup of the Metastore. While our Helm Charts will automatically create all of the objects you need to successfully upgrade, it is best practice to create a snapshot of your Metastore to provide additional fault-tolerance.
Restore a backup
As external Metastores can be set up in a variety of ways, such as on a VM, Cloud SQL, or RDS, guidance on how to restore a backup naturally varies. We recommend reviewing the official PostgreSQL documentation for a better understanding of how you and your organization might approach restoring a backup of an external Metastore.