Skip to main content

​
Upgrade OpenMetadata

In this guide, you will find all the necessary information to safely upgrade your OpenMetadata instance to 1.12.1.

​
Prerequisites

Every time that you plan on upgrading OpenMetadata to a newer version, make sure to go over all these steps:

​
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.
You can learn more about how the migration process works here.During the upgrade, please note that the backup is only for safety and should not be used to restore data to a higher version.
Since version 1.4.0, OpenMetadata encourages using the builtin-tools for creating logical backups of the metadata: For PROD deployment we recommend users to rely on cloud services for their databases, be it AWS RDS, Azure SQL or GCP Cloud SQL. If you’re a user of these services, you can leverage their backup capabilities directly: You can refer to the following guide to get more details about the backup and restore:

Backup Metadata

Learn how to back up MySQL or Postgres data.

​
Understanding the “Running” State in OpenMetadata

In OpenMetadata, the “Running” state indicates that the OpenMetadata server has received a response from Airflow confirming that a workflow is in progress. However, if Airflow unexpectedly stops or crashes before it can send a failure status update through the Failure Callback, OpenMetadata remains unaware of the workflow’s actual state. As a result, the workflow may appear to be stuck in “Running” even though it is no longer executing. This situation can also occur during an OpenMetadata upgrade. If an ingestion pipeline was running at the time of the upgrade and the process caused Airflow to shut down, OpenMetadata would not receive any further updates from Airflow. Consequently, the pipeline status remains “Running” indefinitely. Running State in OpenMetadata

​
Expected Steps to Resolve

To resolve this issue:
  • Ensure that Airflow is restarted properly after an unexpected shutdown.
  • Manually update the pipeline status if necessary.
  • Check Airflow logs to verify if the DAG execution was interrupted.

​
Update sort_buffer_size (MySQL) or work_mem (Postgres)

Before running the migrations, it is important to update these parameters to ensure there are no runtime errors. A safe value would be setting them to 20MB. If using MySQL You can update it via SQL (note that it will reset after the server restarts): 
SET GLOBAL sort_buffer_size = 20971520
To make the configuration persistent, you’d need to navigate to your MySQL Server install directory and update the my.ini or my.cnf files with sort_buffer_size = 20971520. If using RDS, you will need to update your instance’s Parameter Group to include the above change. If using Postgres You can update it via SQL (not that it will reset after the server restarts): 
SET work_mem = '20MB';
To make the configuration persistent, you’ll need to update the postgresql.conf file with work_mem = 20MB. If using RDS, you will need to update your instance’s Parameter Group to include the above change. Note that this value would depend on the size of your query_entity table. If you still see Out of Sort Memory Errors during the migration after bumping this value, you can increase them further. After the migration is finished, you can revert this changes.

Breaking Changes

  • OpenSearch/Elasticsearch Client Upgrade: The search client libraries have been upgraded — the Elasticsearch client to 9.x and the OpenSearch client to 3.x. Users must ensure their search engine servers are on compatible versions:
    • Elasticsearch: Upgrade to 9.x (minimum: 9.0.0, recommended: 9.3.0). The 9.x client is not compatible with 8.x or older servers.
    • OpenSearch: Upgrade to 3.x (minimum: 3.0.0, recommended: 3.3.0). Note that AWS OpenSearch Service currently supports up to OpenSearch 3.3. If using AWS OpenSearch, you might not be able to upgrade from 2.X into 3.X directly. In this case, create a fresh installation with 3.3 and run a reindex. All the index data will be repopulated.
  • Data Contract Schema Changes: Security, SLAs, and Terms of Use can now be inherited from the Data Product’s Data Contract. To support this:
    • Added the inherited property to Security and SLAs.
    • Converted termsOfUse from a simple Markdown field to an object that holds both the markdown information and the inheritance flag.
  • Helm - Updated Airflow Section: The pipelineServiceClientConfig key, previously used to host Airflow configuration directly, has been restructured. OpenMetadata now supports a native Kubernetes orchestration engine in addition to Airflow:
    • Added pipelineServiceClientConfig.type key to switch between airflow or k8s.
    • Moved orchestrator-specific configurations into nested levels: pipelineServiceClientConfig.airflow and pipelineServiceClientConfig.k8s.
    For more details, see PR #436.

​
Upgrade your installation

Once your metadata is safe, follow the required upgrade instructions based on your environment:

Upgrade a Kubernetes Deployment

Upgrade your Kubernetes installation

Upgrade a Docker Deployment

Upgrade your Docker installation

Upgrade a Bare Metal Deployment

Upgrade your Bare Metal installation

​
Post-Upgrade Steps

​
Reindex

​
With UI

Go to Settings -> Applications -> Search Indexing search-index-app Before initiating the process by clicking Run Now, ensure that the Recreate Indexes option is enabled to allow rebuilding the indexes as needed. In the configuration section, you can select the entities you want to reindex. create-project Since this is required after the upgrade, we want to reindex All the entities.

​
(Optional) 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

​
With Kubernetes

Follow these steps to reindex using the CLI:
  1. List the CronJobs Use the following command to check the available CronJobs:
kubectl get cronjobs
Upon running this command you should see output similar to the following. 
kubectl get cronjobs
NAME                    SCHEDULE      TIMEZONE   SUSPEND   ACTIVE   LAST SCHEDULE   AGE
cron-reindex            0/5 * * * *   <none>     True      0        <none>          31m
  1. Create a Job from a CronJob Create a one-time job from an existing CronJob using the following command:
kubectl create job --from=cronjob/cron-deploy-pipelines <job_name>
Replace <job_name> with the actual name of the job.
Upon running this command you should see output similar to the following. 
kubectl create job --from=cronjob/cron-reindex cron-reindex-one
job.batch/cron-reindex-one created
  1. Check the Job Status Verify the status of the created job with:
kubectl get jobs
Upon running this command you should see output similar to the following. 
kubectl get jobs
NAME                       STATUS     COMPLETIONS   DURATION   AGE
cron-reindex-one           Complete   1/1           20s        109s
  1. view logs To view the logs use the below command.
kubectl logs job/<job_name>
Replace <job_name> with the actual job name.
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.2.0. You will find specific instructions for each connector in the Connectors section. 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

​
Re Deploy Ingestion Pipelines

​
With UI

Go to Settings -> {Services} -> {Databases} -> Pipelines redeploy Select the pipelines you want to Re Deploy click Re Deploy.

​
With Kubernetes

Follow these steps to deploy pipelines using the CLI:
  1. List the CronJobs Use the following command to check the available CronJobs:
kubectl get cronjobs
Upon running this command you should see output similar to the following. 
kubectl get cronjobs
NAME                    SCHEDULE      TIMEZONE   SUSPEND   ACTIVE   LAST SCHEDULE   AGE
cron-deploy-pipelines   0/5 * * * *   <none>     True      0        <none>          4m7s
  1. Create a Job from a CronJob Create a one-time job from an existing CronJob using the following command:
kubectl create job --from=cronjob/cron-reindex <job_name>
Replace <job_name> with the actual name of the job.
Upon running this command you should see output similar to the following. 
kubectl create job --from=cronjob/cron-deploy-pipelines cron-deploy-pipeline-one
job.batch/cron-deploy-pipeline-one created
  1. Check the Job Status Verify the status of the created job with:
kubectl get jobs
Upon running this command you should see output similar to the following. 
kubectl get jobs
NAME                       STATUS     COMPLETIONS   DURATION   AGE
cron-deploy-pipeline-one   Complete   1/1           13s        3m35s
  1. view logs To view the logs use the below command.
kubectl logs job/<job_name>
Replace <job_name> with the actual job name.
If you are seeing broken dags select all the pipelines from all the services and re deploy the pipelines.

​
Openmetadata-ops Script

​
Overview

The openmetadata-ops script is designed to manage and migrate databases and search indexes, reindex existing data into Elastic Search or OpenSearch, and redeploy service pipelines.

​
Usage

sh openmetadata-ops.sh [-dhV] [COMMAND]

​
Commands

  • analyze-tables
Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
  • changelog
Prints the change log of database migration.
  • check-connection
Checks if a connection can be successfully obtained for the target database.
  • deploy-pipelines
Deploys all the service pipelines.
  • drop-create
Deletes any tables in the configured database and creates new tables based on the current version of OpenMetadata. This command also re-creates the search indexes.
  • info
Shows the list of migrations applied and the pending migrations waiting to be applied on the target database.
  • migrate
Migrates the OpenMetadata database schema and search index mappings.
  • migrate-secrets
Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
  • reindex
Reindexes data into the search engine from the command line.
  • repair
Repairs the DATABASE_CHANGE_LOG table, which is used to track all the migrations on the target database. This involves removing entries for the failed migrations and updating the checksum of migrations already applied on the target database.
  • validate
Checks if all the migrations have been applied on the target database.

​
Examples

Display Help To display the help message: 
sh openmetadata-ops.sh --help

​
Migrate Database Schema

To migrate the database schema and search index mappings: 
sh openmetadata-ops.sh migrate

​
Reindex Data

To reindex data into the search engine: 
sh openmetadata-ops.sh reindex