4.4 KiB
Prerequisites
Everytime that you plan on upgrading OpenMetadata to a newer version, make sure to go over all these steps:
1. Backup your Metadata
Before upgrading your OpenMetadata version we strongly recommend backing up the metadata.
The source of truth is stored in the underlying database (MySQL and Postgres supported). During each version upgrade there is a database migration process that needs to run. It will directly attack your database and update the shape of the data to the newest OpenMetadata release.
It is important that we backup the data because if we face any unexpected issues during the upgrade process, you will be able to get back to the previous version without any loss.
{% note %}
You can learn more about how the migration process works here.
{% /note %}
- To run the backup and restore commands, please make sure that you are always in the latest
openmetadata-ingestionversion to have all the improvements shipped in the CLI. - Also, make sure you have connectivity between your database (MySQL / PostgreSQL) and the host machine where you will be running the below commands.
1. Create a Virtual Environment and Install the Backup CLI
python -m venv venv
source venv/bin/activate
pip install openmetadata-ingestion~=1.1.1
Validate the installed metadata version with python -m metadata --version
2. Run the Backup
If using MySQL:
python -m metadata backup -u openmetadata_user -p openmetadata_password -H mysql -d openmetadata_db --port 3306
If using Postgres:
python -m metadata backup -u openmetadata_user -p openmetadata_password -H postgresql -d openmetadata_db --port 5432 -s public
3. Store the backup file somewhere safe
The above command will generate a backup file with extension as .sql. You can copy the name from the backup command output.
Make sure to store it somewhere safe in case you need to restore the data later.
You can refer to the following guide to get more details about the backup and restore:
{% inlineCalloutContainer %} {% inlineCallout color="violet-70" icon="luggage" bold="Backup Metadata" href="/deployment/backup-restore-metadata" %} Learn how to back up MySQL or Postgres data. {% /inlineCallout %} {% /inlineCalloutContainer %}
2. Review the Deprecation Notice and Breaking Changes
Releases might introduce deprecations and breaking changes that you should be aware of and understand before moving forward.
Below in this page you will find the details for the latest release, and you can find older release notes here.
The goal is to answer questions like:
- Do I need to update my configurations?
- If I am running connectors externally, did their service connection change?
Carefully reviewing this will prevent easy errors.
(Optional) 3. Update your OpenMetadata Ingestion Client
If you are running the ingestion workflows externally or using a custom Airflow installation, you need to make sure that the Python Client you use is aligned with the OpenMetadata server version.
For example, if you are upgrading the server to the version x.y.z, you will need to update your client with
pip install openmetadata-ingestion[<plugin>]==x.y.z
The plugin parameter is a list of the sources that we want to ingest. An example would look like this openmetadata-ingestion[mysql,snowflake,s3]==1.1.5.
You will find specific instructions for each connector here.
Moreover, if working with your own Airflow deployment - not the openmetadata-ingestion image - you will need to upgrade
as well the openmetadata-managed-apis version:
pip install openmetadata-managed-apis==x.y.z
Deprecation Notice
- OpenMetadata only supports Python version 3.8 to 3.10.
Breaking Changes for 1.2 Stable Release
Query Entity
The Query Entity now has the service property, linking the Query to the Database Service that it belongs to. Note
that service is a required property both for the Query Entity and the Create Query Entity.
During the migrations, we pick up the service from the tables from queryUsedIn. If this information is not available,
then there is no way to link a query to a service and the query will be removed.
Service Connection Changes
- Domo Database, Dashboard and Pipeline renamed the
sandboxDomainin favor ofinstanceDomain.