yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-25 22:49:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] - Add upgrade & release docs (#11274)

Browse Source 
* Add upgrade docs on top

* Add upgrade links in release
This commit is contained in:
Pere Miquel Brull 2023-04-25 18:43:08 +02:00 committed by GitHub
parent 0d9ec54b55
commit 8d73973ad2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 81 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
openmetadata-docs-v1/content/v1.0.0/deployment/upgrade/index.md
View File

@ -12,11 +12,58 @@ The OpenMetadata community will be doing feature releases and stable releases.
- Feature releases are to upgrade your sandbox or POCs to give feedback to the community and any potential bugs that the community needs to fix.
- Stable releases are to upgrade your production environments and share it with your users.
## Backup Metadata
Before upgrading your OpenMetadata version we recommend backing up the metadata.
The source of truth is stored in the underlying database (MySQL and Postgres supported). You can refer
to the following guide for our backup utility:
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="luggage"
bold="Backup Metadata"
href="/deployment/backup-restore-metadata" %}
Learn how to back up MySQL data.
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## Upgrade your installation
Once your metadata is safe, follow the required upgrade instructions:
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="fit_screen"
bold="Upgrade a Kubernetes Deployment"
href="/deployment/upgrade/kubernetes" %}
Upgrade your Kubernetes installation
{% /inlineCallout %}
{% inlineCallout
color="violet-70"
icon="celebration"
bold="Upgrade a Docker Deployment"
href="/deployment/upgrade/docker" %}
Upgrade your Docker installation
{% /inlineCallout %}
{% inlineCallout
color="violet-70"
icon="storage"
bold="Upgrade a Bare Metal Deployment"
href="/deployment/upgrade/bare-metal" %}
Upgrade your Bare Metal installation
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## 1.0 - Stable Release 🎉
OpenMetadata 1.0 is a stable release. Please check the [release notes](/releases/latest-release).
If you are upgrading production this is the recommended version to upgrade.
If you are upgrading production this is the recommended version to upgrade to.
## Breaking Changes for 1.0 Stable Release
@ -105,50 +152,3 @@ Note that this property is OPTIONAL, and for the most cases it will either be le
### Python SDK Submodules name change
- **`metadata.test_suite.*`**: this submodule has been renamed `metadata.data_quality.*`. You can view the full change [here](https://github.com/open-metadata/OpenMetadata/pull/10890/files)
- **`metadata.orm_profiler.*`**: this submodule has been renamed `metadata.profiler.*`. You can view the full change [here](https://github.com/open-metadata/OpenMetadata/pull/10350/files)
## Backup Metadata
Before upgrading your OpenMetadata version we recommend backing up the metadata.
The source of truth is stored in the underlying database (MySQL and Postgres supported). You can refer
to the following guide for our backup utility:
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="luggage"
bold="Backup Metadata"
href="/deployment/backup-restore-metadata" %}
Learn how to back up MySQL data.
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## Upgrade your installation
Once your metadata is safe, follow the required upgrade instructions:
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="fit_screen"
bold="Upgrade a Kubernetes Deployment"
href="/deployment/upgrade/kubernetes" %}
Upgrade your Kubernetes installation
{% /inlineCallout %}
{% inlineCallout
color="violet-70"
icon="celebration"
bold="Upgrade a Docker Deployment"
href="/deployment/upgrade/docker" %}
Upgrade your Docker installation
{% /inlineCallout %}
{% inlineCallout
color="violet-70"
icon="storage"
bold="Upgrade a Bare Metal Deployment"
href="/deployment/upgrade/bare-metal" %}
Upgrade your Bare Metal installation
{% /inlineCallout %}
{% /inlineCalloutContainer %}

11
openmetadata-docs-v1/content/v1.0.0/releases/index.md
View File

@ -5,6 +5,17 @@ slug: /releases
# 1.0 Release 🎉
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="celebration"
bold="Upgrade OpenMetadata"
href="/deployment/upgrade" %}
Learn how to upgrade your OpenMetadata instance to 1.0!
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## APIs & Schema
- **Stabilized** and improved the Schemas and APIs.
- The APIs are **backward compatible**.

11
openmetadata-docs-v1/content/v1.0.0/releases/releases/index.md
View File

@ -14,6 +14,17 @@ version. To see what's coming in next releases, please check our [Roadmap](/rele
# 1.0 Release 🎉
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="celebration"
bold="Upgrade OpenMetadata"
href="/deployment/upgrade" %}
Learn how to upgrade your OpenMetadata instance to 1.0!
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## APIs & Schema
- **Stabilized** and improved the Schemas and APIs.
- The APIs are **backward compatible**.

11
openmetadata-docs-v1/content/v1.0.0/releases/releases/latest.md
View File

@ -5,6 +5,17 @@ slug: /releases/latest-release
# 1.0 Release 🎉
{% inlineCalloutContainer %}
{% inlineCallout
color="violet-70"
icon="celebration"
bold="Upgrade OpenMetadata"
href="/deployment/upgrade" %}
Learn how to upgrade your OpenMetadata instance to 1.0!
{% /inlineCallout %}
{% /inlineCalloutContainer %}
## APIs & Schema
- **Stabilized** and improved the Schemas and APIs.
- The APIs are **backward compatible**.