8.2 KiB
Prerequisites
Everytime 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.
{% note %}
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.
{% /note %}
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:
{% 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 %}
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.
Backward Incompatible Changes
1.6.0
Ingestion Workflow Status
We are updating how we compute the success percentage. Previously, we took into account for partial success the results of the Source (e.g., the tables we were able to properly retrieve from Snowflake, Redshift, etc.). This means that we had an error threshold in there were if up to 90% of the tables were successfully ingested, we would still consider the workflow as successful. However, any errors when sending the information to OpenMetadata would be considered as a failure.
Now, we're changing this behavior to consider the success rate of all the steps involved in the workflow. The UI will
then show more Partial Success statuses rather than Failed, properly reflecting the real state of the workflow.
Database Metadata & Lineage Workflow
With 1.6 Release we are moving the View Lineage & Stored Procedure Lineage computation from metadata workflow to lineage workflow.
This means that we are removing the overrideViewLineage property from the DatabaseServiceMetadataPipeline schema which will be moved to the DatabaseServiceQueryLineagePipeline schema.
Profiler & Auto Classification Workflow
We are creating a new Auto Classification workflow that will take care of managing the sample data and PII classification,
which was previously done by the Profiler workflow. This change will allow us to have a more modular and scalable system.
The Profiler workflow will now only focus on the profiling part of the data, while the Auto Classification will take care of the rest.
This means that we are removing these properties from the DatabaseServiceProfilerPipeline schema:
generateSampleDataprocessPiiSensitiveconfidencewhich will be moved to the newDatabaseServiceAutoClassificationPipelineschema.
What you will need to do:
- If you are using the EXTERNAL ingestion for the profiler (YAML configuration), you will need to update your configuration, removing these properties as well.
- If you still want to use the Auto PII Classification and sampling features, you can create the new workflow from the UI.
RBAC Policy Updates for EditTags
We have given more granularity to the EditTags policy. Previously, it was a single policy that allowed the user to manage
any kind of tagging to the assets, including adding tags, glossary terms, and Tiers.
Now, we have split this policy to give further control on which kind of tagging the user can manage. The EditTags policy has been
split into:
EditTags: to add tags.EditGlossaryTerms: to add Glossary Terms.EditTier: to add Tier tags.
Collate - Metadata Actions for ML Tagging - Deprecation Notice
Since we are introducing the Auto Classification workflow, we are going to remove in 1.7 the ML Tagging action
from the Metadata Actions. That feature will be covered already by the Auto Classification workflow, which even brings
more flexibility allow the on-the-fly usage of the sample data for classification purposes without having to store
it in the database.
Service Spec for the Ingestion Framework
This impacts users who maintain their own connectors for the ingestion framework that are NOT part of the
OpenMetadata python library (openmetadata-ingestion).
Introducing the "connector specifcication class (ServiceSpec)".
The ServiceSpec class serves as the entrypoint for the connector and holds the references for the classes that will be used
to ingest and process the metadata from the source.
You can see postgres for an
implementation example.
Fivetran
The filtering of Fivetran pipelines now supports using their names instead of IDs. This change may affect existing configurations that rely on pipeline IDs for filtering.
DBT Cloud Pipeline Service
We are removing the field jobId which we required to ingest dbt metadata from a specific job, instead of this we added a new field called jobIds which will accept multiple job ids to ingest metadata from multiple jobs.
MicroStrategy
The serviceType for MicroStrategy connector is renamed from Mstr to MicroStrategy.