[FIX] Updating 1.1.2 Documentation with the required fixes (#13006)

Co-authored-by: Dhruvin Maniar <dhruvinmaniar@192.168.1.24>
This commit is contained in:
Dhruvin Maniar 2023-08-25 19:42:14 +05:30 committed by GitHub
parent 60eaeecf25
commit fa67ce01d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 71 additions and 15 deletions

View File

@ -27,7 +27,7 @@ You can learn more about how the migration process works [here](/deployment/upgr
```python
python -m venv venv
source venv/bin/activate
pip install openmetadata-ingestion~=1.1.1
pip install openmetadata-ingestion~=1.1.2
```
Validate the installed metadata version with `python -m metadata --version`
@ -87,20 +87,76 @@ For example, if you are upgrading the server to the version `x.y.z`, you will ne
pip install openmetadata-ingestion[<plugin>]==x.y.z
```
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.1.1`.
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.1.2`.
You will find specific instructions for each connector [here](/connectors).
## 1.1.1 - Stable Release 🎉
## 1.1.2 - Stable Release 🎉
OpenMetadata 1.1 is a stable release. Please check the [release notes](/releases/latest-release).
OpenMetadata 1.1.2 is a stable release. Please check the [release notes](/releases/latest-release).
If you are upgrading production this is the recommended version to upgrade to.
## Deprecation Notice
In 1.2 we will completely remove the Bots configured with SSO. Only JWT will be available then. Please, upgrade your bots if you haven't done so. Note that the UI already does not allow creating bots with SSO.
## Breaking Changes for 1.1.2 Stable Release
**Openmetadata yaml config updates**
Following are the changes in the `openmetadata.yaml` which needs to be verified before going forward:
1. Searchtype has been added in the `elasticsearch` configuration to choose between `opensearch` or `elasticsearch`:
```
elasticsearch:
searchType: ${SEARCH_TYPE:- "elasticsearch"}
```
2. Migration configuration:
```
migrationConfiguration:
flywayPath: "./bootstrap/sql/migrations/flyway"
nativePath: "./bootstrap/sql/migrations/native"
```
3. Web Configuration:
```
web:
uriPath: ${WEB_CONF_URI_PATH:-"/api"}
hsts:
enabled: ${WEB_CONF_HSTS_ENABLED:-false}
maxAge: ${WEB_CONF_HSTS_MAX_AGE:-"365 days"}
includeSubDomains: ${WEB_CONF_HSTS_INCLUDE_SUBDOMAINS:-"true"}
preload: ${WEB_CONF_HSTS_PRELOAD:-"true"}
frame-options:
enabled: ${WEB_CONF_FRAME_OPTION_ENABLED:-false}
option: ${WEB_CONF_FRAME_OPTION:-"SAMEORIGIN"}
origin: ${WEB_CONF_FRAME_ORIGIN:-""}
content-type-options:
enabled: ${WEB_CONF_CONTENT_TYPE_OPTIONS_ENABLED:-false}
xss-protection:
enabled: ${WEB_CONF_XSS_PROTECTION_ENABLED:-false}
on: ${WEB_CONF_XSS_PROTECTION_ON:-true}
block: ${WEB_CONF_XSS_PROTECTION_BLOCK:-true}
csp:
enabled: ${WEB_CONF_XSS_CSP_ENABLED:-false}
policy: ${WEB_CONF_XSS_CSP_POLICY:-"default-src 'self'"}
reportOnlyPolicy: ${WEB_CONF_XSS_CSP_REPORT_ONLY_POLICY:-""}
referrer-policy:
enabled: ${WEB_CONF_REFERRER_POLICY_ENABLED:-false}
option: ${WEB_CONF_REFERRER_POLICY_OPTION:-"SAME_ORIGIN"}
permission-policy:
enabled: ${WEB_CONF_PERMISSION_POLICY_ENABLED:-false}
option: ${WEB_CONF_PERMISSION_POLICY_OPTION:-""}
```
## Breaking Changes for 1.1 Stable Release
### Service Connection Changes
### Other Changes
`Trino` has deprecated the params property. The contents will automatically be passed to `connectionOptions`. We have added support for authType to distinguish between `basicAuth` and `jwtAuth`.

View File

@ -97,7 +97,7 @@ This docker compose file contains only the docker compose services for OpenMetad
You can also run the below command to fetch the docker compose file directly from the terminal -
```bash
wget https://github.com/open-metadata/OpenMetadata/releases/download/1.1.1-release/docker-compose-openmetadata-server.yml
wget https://github.com/open-metadata/OpenMetadata/releases/download/1.1.2-release/docker-compose-openmetadata-server.yml
```
### 3. Update Environment Variables required for OpenMetadata Dependencies

View File

@ -5,7 +5,7 @@ slug: /deployment/upgrade
# Upgrade OpenMetadata
{% partial file="/v1.1.2/deployment/upgrade/upgrade-prerequisites-111.md" /%}
{% partial file="/v1.1.2/deployment/upgrade/upgrade-prerequisites-112.md" /%}
## Upgrade your installation

View File

@ -119,15 +119,15 @@ The latest version is at the top of the page
You can use the curl or wget command as well to fetch the docker compose files from your terminal -
```commandline
curl -sL https://github.com/open-metadata/OpenMetadata/releases/download/1.1.0-release/docker-compose.yml
curl -sL https://github.com/open-metadata/OpenMetadata/releases/download/1.1.2-release/docker-compose.yml
curl -sL https://github.com/open-metadata/OpenMetadata/releases/download/1.1.0-release/docker-compose-postgres.yml
curl -sL https://github.com/open-metadata/OpenMetadata/releases/download/1.1.2-release/docker-compose-postgres.yml
```
```commandline
wget -O https://github.com/open-metadata/OpenMetadata/releases/download/1.1.0-release/docker-compose.yml
wget -O https://github.com/open-metadata/OpenMetadata/releases/download/1.1.2-release/docker-compose.yml
wget -O https://github.com/open-metadata/OpenMetadata/releases/download/1.1.0-release/docker-compose-postgres.yml
wget -O https://github.com/open-metadata/OpenMetadata/releases/download/1.1.2-release/docker-compose-postgres.yml
```
### 3. Start the Docker Compose Services
@ -166,10 +166,10 @@ You can validate that all containers are up by running with command `docker ps`.
```commandline
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
470cc8149826 openmetadata/server:1.1.0 "./openmetadata-star…" 45 seconds ago Up 43 seconds 3306/tcp, 9200/tcp, 9300/tcp, 0.0.0.0:8585-8586->8585-8586/tcp openmetadata_server
63578aacbff5 openmetadata/ingestion:1.1.0 "./ingestion_depende…" 45 seconds ago Up 43 seconds 0.0.0.0:8080->8080/tcp openmetadata_ingestion
470cc8149826 openmetadata/server:1.1.2 "./openmetadata-star…" 45 seconds ago Up 43 seconds 3306/tcp, 9200/tcp, 9300/tcp, 0.0.0.0:8585-8586->8585-8586/tcp openmetadata_server
63578aacbff5 openmetadata/ingestion:1.1.2 "./ingestion_depende…" 45 seconds ago Up 43 seconds 0.0.0.0:8080->8080/tcp openmetadata_ingestion
9f5ee8334f4b docker.elastic.co/elasticsearch/elasticsearch:7.16.3 "/tini -- /usr/local…" 45 seconds ago Up 44 seconds 0.0.0.0:9200->9200/tcp, 0.0.0.0:9300->9300/tcp openmetadata_elasticsearch
08947ab3424b openmetadata/db:1.1.0 "/entrypoint.sh mysq…" 45 seconds ago Up 44 seconds (healthy) 3306/tcp, 33060-33061/tcp openmetadata_mysql
08947ab3424b openmetadata/db:1.1.2 "/entrypoint.sh mysq…" 45 seconds ago Up 44 seconds (healthy) 3306/tcp, 33060-33061/tcp openmetadata_mysql
```
In a few seconds, you should be able to access the OpenMetadata UI at [http://localhost:8585](http://localhost:8585)