Add note on breaking changes introduced with OM 0.12.1 (#7992)

This commit is contained in:
Akash Jain 2022-10-07 01:02:17 +05:30 committed by GitHub
parent b6ba929046
commit 1724ede39e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 100 additions and 0 deletions

View File

@ -14,6 +14,12 @@ This guide assumes that you have an OpenMetadata deployment that you installed a
## Procedure
<Warning>
It is adviced to go through [openmetadata release notes](/deployment/upgrade#breaking-changes-from-0121-release) before starting the upgrade process. We have introduced major stability and security changes as part of 0.12.1 OpenMetadata Release.
</Warning>
### 1. Download the binaries for the release you want to install
OpenMetadata release binaries are maintained as GitHub releases.

View File

@ -16,6 +16,12 @@ You can find more details about Docker deployment [here](/deployment/docker)
Below we have highlighted the steps needed to upgrade to the latest version with Docker. Make sure to also look [here](/deployment/upgrade/versions/011-to-012) for the specific details related to upgrading to 0.12
<Warning>
It is adviced to go through [openmetadata release notes](/deployment/upgrade#breaking-changes-from-0121-release) before starting the upgrade process. We have introduced major stability and security changes as part of 0.12.1 OpenMetadata Release.
</Warning>
### 1. Download docker-compose.yaml file
Go to [github.com/open-metadata/OpenMetadata/releases](https://github.com/open-metadata/OpenMetadata/releases). The latest release will be at the top of this page.

View File

@ -16,7 +16,89 @@ OpenMetadata community will be doing feature releases and stable releases.
OpenMetadata 0.12.1 is a stable release. For Release notes please check here
Join our slack https://slack.open-metadata.org provide your feedback and help community to get to the stable 0.12.1 release
## Breaking Changes from 0.12.1 Release
OpenMetadata Release 0.12.1 introduces below breaking changes -
### Change of OpenMetadata Service Namespace
Under the [openmetadata.yaml](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml), all the class names are updated from `org.openmetadata.catalog.*` to `org.openmetadata.service.*`.
- If you are using a previous version of openmetadata.yaml config file with [bare metal](/deployment/bare-metal) installation, make sure to migrate all these values as per new openmetadata.yaml configurations. Check the below example code snippet from openmetadata.yaml configuration
```yaml
...
authorizerConfiguration:
className: ${AUTHORIZER_CLASS_NAME:-org.openmetadata.service.security.DefaultAuthorizer}
containerRequestFilter: ${AUTHORIZER_REQUEST_FILTER:-org.openmetadata.service.security.JwtFilter}
...
```
- If you are using [docker](/deployment/docker) installation with your custom env file, update all the environement variables from `org.openmetadata.catalog.*` to `org.openmetadata.service.*`.
```
AUTHORIZER_CLASS_NAME=org.openmetadata.service.security.DefaultAuthorizer
AUTHORIZER_REQUEST_FILTER=org.openmetadata.service.security.JwtFilter
```
- If you are running openmetadata on [kubernetes with helm charts](/deployment/kubernetes), make sure to update `global.authorizer.className` and `global.authorizer.containerRequestFilter` with below values for your custom openmetadata helm chart values file.
```yaml
global:
...
authorizer:
className: "org.openmetadata.service.security.DefaultAuthorizer"
containerRequestFilter: "org.openmetadata.service.security.JwtFilter"
...
```
### Centralising of openmetadata/ingestion and openmetadata/airflow docker images
Starting 0.12.1 Release, we have centralized openmetadata/airflow and openmetadata/ingestion docker images
with openmetadata/ingestion docker image which will be used with docker compose installation and kubernetes helm chart installation. This docker image is based on apache-airflow 2.3.3 image with python 3.9.9. This will be a rootless docker image for enhanced security.
- There is no change or effect with docker installation
- This is a breaking change if you are using a custom openmetadata-dependencies kubernetes helm chart values file.
You will need to manually update the airflow image and tag with openmetadata/ingestion:0.12.1
```yaml
...
airflow:
airflow:
image:
repository: openmetadata/ingestion
tag: 0.12.1
pullPolicy: "IfNotPresent"
...
```
<p>
If you are extending openmetadata/airflow docker image with 0.12.0 release, you can safely replace that with openmetadata/ingestion:0.12.1 Docker Image.
</p>
```Dockerfile
FROM openmetadata/ingestion:0.12.1
USER airflow
...
```
### Basic Authentication enabled by default
We have deprecated and removed no-auth as the authentication mechanism starting 0.12.1 Release with OpenMetadata.
The default Authentication mechanism will be basic authentication. You can login to OpenMetadata UI with below default credentials -
```
Username - admin
Password - admin
```
### Enabled JWT Token Configuration by default
Starting 0.12.1 Release, OpenMetadata Installation will provide a default configuration that will enable JWT Token Configuration for the OpenMetadata Instance.
If you want to setup a production Open Metadata instance, it is recommended to follow [enable jwt tokens](/deployment/security/enable-jwt-tokens) to setup and configure your own JWT Token configurations.
## Backup Metadata

View File

@ -17,6 +17,12 @@ We also assume that your helm chart release names are `openmetadata` and `openme
## Procedure
<Warning>
It is adviced to go through [openmetadata release notes](/deployment/upgrade#breaking-changes-from-0121-release) before starting the upgrade process. We have introduced major stability and security changes as part of 0.12.1 OpenMetadata Release.
</Warning>
Below document is valid for upgrading Helm Charts from **0.11.5 to 0.12.X**.
### Back up metadata