Upgrade on Bare Metal
This guide will help you upgrade an OpenMetadata deployment using release binaries.
This guide assumes that you have an OpenMetadata deployment that you installed and configured following the Bare Metal deployment guide.
It is adviced to go through openmetadata release notes before starting the upgrade process.
Backup your data
To run the backup and restore commands, please make sure that you are always in the latest
openmetadata-ingestion version to have all the improvements shipped in the CLI.
- Make sure your instance is connected to the Database server
- Create a virtual environment to install an upgraded
metadataversion to run the backup command:
python -m venv venv
pip install openmetadata-ingestion~=1.0.0
- Validate the installed
python -m metadata --version, which should tell us that we are indeed at 1.0.0. Notice the
python -m metadatavs.
- Run the backup using the updated
metadataCLI:Or if using postgres:
- This will generate the .sql file which can be used for the backup In our case, the backup file was named
openmetadata_202212201528_backup.sql. You can copy the name from the backup command output.
1. Download the binaries for the release you want to install
OpenMetadata release binaries are maintained as GitHub releases.
To download a specific release binary:
- Visit github.com/open-metadata/OpenMetadata/releases. The latest release will be at the top of this page.
- Locate the Assets' section for the release you want to upgrade to.
- Download the release binaries. The release binaries will be in a compressed tar file named using the following convention,
zare the major, minor, and patch release numbers, respectively.
2. Extract the release binaries from the download file
Using the command-line tool or application of your choice, extract the release binaries.
For example, to extract using
tar, run the following command.
This will create a directory with the same name as the download file minus the
3. Navigate into the directory created by extracting the release binaries
Change into the new directory by issuing a command similar to the following.
For example, to navigate into the directory created by issuing the tar command above, you would run the following command.
4. Stop the OpenMetadata server
OpenMetadata ships with a few control scripts. One is
openmetadata.sh. This script enables you to start, stop, and perform other deployment operations on the OpenMetadata server.
Most OpenMetadata releases will require you to migrate your data to updated schemas.
Before you migrate your data to the new release you are upgrading to, stop the OpenMetadata server from the directory of your current installation by running the following command:
5. Migrate the database schemas and ElasticSearch indexes
The bootstrap/bootstrap_storage.sh script enables you to perform a number of operations on the OpenMetadata database (in MySQL) and index (in Elasticsearch).
6. Restart the OpenMetadata server
Once you've dropped and recreated your data in the new version, restart the OpenMetadata server using the new release binaries. You may restart the server by running the following command.
Optional - Upgrade all your connectors
If you are ingesting data manually or in a custom scheduler using OpenMetadata connectors, upgrade all your connectors by running the following command for each connector.
You will need to replace
<connectorname> in the command below with the name of the connector you are upgrading.
Re-index all your metadata
Go to Settings -> Elasticsearch
Click on reindex all
in the dialog box choose Recreate Indexes to All