From f687975eddd4b7815582c128e69d8540d9eedd1a Mon Sep 17 00:00:00 2001 From: Sriharsha Chintalapani Date: Mon, 12 Dec 2022 09:58:41 -0800 Subject: [PATCH] Fix deployment docs (#9229) * Fix deployment docs * Fix deployment docs * Fix deployment docs * Update openmetadata-docs/content/deployment/bare-metal/index.md Co-authored-by: Pere Miquel Brull Co-authored-by: Pere Miquel Brull --- .../content/deployment/bare-metal/index.md | 48 +++++++++++++++---- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/openmetadata-docs/content/deployment/bare-metal/index.md b/openmetadata-docs/content/deployment/bare-metal/index.md index c8769896f65..cdf114169e6 100644 --- a/openmetadata-docs/content/deployment/bare-metal/index.md +++ b/openmetadata-docs/content/deployment/bare-metal/index.md @@ -39,6 +39,17 @@ You can refer a sample script [here](https://github.com/open-metadata/OpenMetada +## Postgres (version between 12.0 and 14.6) + +To install Postgres see the instructions for your operating system (OS) at [Postgres Download](https://www.postgresql.org/download/) + + +Make sure to configure required databases and users for OpenMetadata. + +You can refer a sample script [here](https://github.com/open-metadata/OpenMetadata/blob/main/docker/local-metadata/postgres-script.sql). + + + ## Elasticsearch (version 7.X) @@ -155,7 +166,7 @@ server { } ``` -## Run OpenMetadata with AWS Services +## Run OpenMetadata with AWS Services or your hosted DB/ElasticSearch If you are running OpenMetadata in AWS, it is recommended to use [Amazon RDS](https://docs.aws.amazon.com/rds/index.html) and [Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/?id=docs_gateway). @@ -169,18 +180,39 @@ For Production Systems, we recommend Amazon RDS to be in Multiple Availability Z Once you have the RDS and OpenSearch Services Setup, you can update the environment variables below for OpenMetadata bare metal systems to connect with Database and ElasticSearch. + +Below are the environment variables for OpenMetadata Server + +### Configure MySQL connection + ``` # MySQL Environment Variables DB_DRIVER_CLASS='com.mysql.cj.jdbc.Driver' DB_SCHEME='mysql' DB_USE_SSL='true' -MYSQL_USER_PASSWORD='' -DB_SCHEME='mysql' -MYSQL_HOST='' -MYSQL_USER='' -MYSQL_DATABASE='' -MYSQL_PORT='' -# ElasticSearch Environment Variables +DB_USER='' +DB_USER_PASSWORD='' +DB_HOST='' +DB_PORT='' +OM_DATABASE='' +``` + +### Configure Postgres Connection + +``` +# Postgres Environment Variables +DB_DRIVER_CLASS='org.postgresql.Driver' +DB_SCHEME='postgresql' +DB_USE_SSL='true' +DB_USER='' +DB_USER_PASSWORD='' +DB_HOST='' +DB_PORT='' +OM_DATABASE='' +``` + +### Configure ElasticSearch Connection +``` ELASTICSEARCH_SOCKET_TIMEOUT_SECS='60' ELASTICSEARCH_USER='' ELASTICSEARCH_CONNECTION_TIMEOUT_SECS='5'