Upgrade on Docker

To run OpenMetadata with Docker, you can simply download the docker-compose.yml file. Optionally, we added some Named Volumes to handle data persistence.

Below we have highlighted the steps needed to upgrade to the latest version with Docker. Make sure to also look here for the specific details related to upgrading to 1.0.0

Upgrade from 0.13 to 1.0.0

Your production deployment should go from stable version to stable version. This translated to moving from 0.13 to 1.0.0 to get the latest stable OpenMetadata release.

Let's go through the required steps:

1. Backup Existing OpenMetadata Data using Metadata CLI

• Make sure your instance is connected to the Database server
• Create a virtual environment to install an upgraded metadata version to run the backup command:
• Validate the installed metadata version with python -m metadata --version, which should tell us that we are indeed at 1.0.0. Notice the python -m metadata vs. metadata.
• Run the backup using the updated metadata CLI: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.

2. Replace the docker compose file

• Stop the running compose deployment with below command

• Download the Docker Compose Service File from OpenMetadata Github Release page here
• Replace the existing Docker Compose Service File with the one downloaded from the above step

• Start the Docker Compose Service with the below command

3. Re-index all your metadata

Go to Settings -> OpenMetadata -> Search

Reindex

Click on reindex all.

In the dialog box choose Recreate Indexes to All.

Reindex

Upgrade ingestion patch versions

During the release lifespan we may publish new patch versions of openmetadata-ingestion. If you deployed the ingestion container and require one of the fixes or improvements from a new patch release, there's usually no need to re-deploy the full ingestion container.

The steps to follow are:

• Connect to the ingestion container. If using our docker compose files or metadata docker CLI, this translates to
• Validate your metadata version via metadata --version. You will get back something like:
• Upgrade the openmetadata-ingestion package via pip install "openmetadata-ingestion==0.13.1.X",for example,You can find the list of all released versions of the openmetadata-ingestion package here.
• Exit the container by typing exit.
• Restart the ingestion container with docker restart openmetadata_ingestion. This will need a few minutes to to stop the container and start it again. Now, Airflow will start with the upgraded metadata version.
• Connect to the ingestion container and validate the metadata version:
  • metadata version: where we expect to get the same version that was previously installed.

Troubleshooting

Permission Denied when running metadata openmetadata-imports-migration

If you have a Permission Denied error thrown when running metadata openmetadata-imports-migration --change-config-file-path you might need to change the permission on the /opt/airflow/dags folder. SSH into the ingestion container and check the permission on the folder running the below commands

both the dags folder and the files inside dags/ should have airflow root permission. if this is not the case simply run the below command

Broken DAGs can't load config file: Permission Denied

You might need to change the permission on the /opt/airflow/dag_generated_config folder. SSH into the ingestion container and check the permission on the folder running the below commands

both the dags folder and the files inside dags/ should have airflow root permission. if this is not the case simply run the below command