Docs: Bare Metal Configuration Addition (#19539)

Co-authored-by: Rounak Dhillon <[email protected]>
open-metadata · Jan 27, 2025 · 8117586 · 8117586
1 parent b1d481f
commit 8117586
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 0 deletions.
diff --git a/openmetadata-docs/content/v1.6.x/deployment/bare-metal/index.md b/openmetadata-docs/content/v1.6.x/deployment/bare-metal/index.md
@@ -220,6 +220,43 @@ ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com'
 ELASTICSEARCH_PASSWORD='<ES_PASSWORD>'
 ```
 
+### Configure OpenSearch
+```
+# ElasticSearch Configurations
+SEARCH_TYPE="opensearch"
+ELASTICSEARCH_HOST="<OPENSEARCH_ENDPOINT>"
+ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
+ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
+ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
+ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
+...
+```
+
+### Configure Ingestion
+
+```
+PIPELINE_SERVICE_CLIENT_ENDPOINT="<INGESTION_ENDPOINT_URL_WITH_SCHEME>"
+PIPELINE_SERVICE_CLIENT_HEALTH_CHECK_INTERVAL="300"
+SERVER_HOST_API_URL="<OPENMETADATA_ENDPOINT_URL_WITH_SCHEME>/api"
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL="no-ssl"
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=""
+PIPELINE_SERVICE_CLIENT_CLASS_NAME="org.openmetadata.service.clients.pipeline.airflow.AirflowRESTClient"
+PIPELINE_SERVICE_IP_INFO_ENABLED="false"
+PIPELINE_SERVICE_CLIENT_HOST_IP=""
+PIPELINE_SERVICE_CLIENT_SECRETS_MANAGER_LOADER="noop"
+AIRFLOW_USERNAME="<AIRFLOW_UI_LOGIN_USERNAME>"
+AIRFLOW_PASSWORD="<AIRFLOW_UI_LOGIN_PASSWORD>"
+AIRFLOW_TIMEOUT="10"
+AIRFLOW_TRUST_STORE_PATH=""
+AIRFLOW_TRUST_STORE_PASSWORD=""
+```
+
+{% note noteType="Warning" %}
+
+When setting up environment file if your custom password includes any special characters then make sure to follow the steps [here](https://github.com/open-metadata/OpenMetadata/issues/12110#issuecomment-1611341650).
+
+{% /note %}
+
 ## Troubleshooting
 
 ### Java Memory Heap Issue

diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/bare-metal/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/bare-metal/index.md
@@ -220,6 +220,43 @@ ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com'
 ELASTICSEARCH_PASSWORD='<ES_PASSWORD>'
 ```
 
+### Configure OpenSearch
+```
+# ElasticSearch Configurations
+SEARCH_TYPE="opensearch"
+ELASTICSEARCH_HOST="<OPENSEARCH_ENDPOINT>"
+ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
+ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
+ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
+ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
+...
+```
+
+### Configure Ingestion
+
+```
+PIPELINE_SERVICE_CLIENT_ENDPOINT="<INGESTION_ENDPOINT_URL_WITH_SCHEME>"
+PIPELINE_SERVICE_CLIENT_HEALTH_CHECK_INTERVAL="300"
+SERVER_HOST_API_URL="<OPENMETADATA_ENDPOINT_URL_WITH_SCHEME>/api"
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL="no-ssl"
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=""
+PIPELINE_SERVICE_CLIENT_CLASS_NAME="org.openmetadata.service.clients.pipeline.airflow.AirflowRESTClient"
+PIPELINE_SERVICE_IP_INFO_ENABLED="false"
+PIPELINE_SERVICE_CLIENT_HOST_IP=""
+PIPELINE_SERVICE_CLIENT_SECRETS_MANAGER_LOADER="noop"
+AIRFLOW_USERNAME="<AIRFLOW_UI_LOGIN_USERNAME>"
+AIRFLOW_PASSWORD="<AIRFLOW_UI_LOGIN_PASSWORD>"
+AIRFLOW_TIMEOUT="10"
+AIRFLOW_TRUST_STORE_PATH=""
+AIRFLOW_TRUST_STORE_PASSWORD=""
+```
+
+{% note noteType="Warning" %}
+
+When setting up environment file if your custom password includes any special characters then make sure to follow the steps [here](https://github.com/open-metadata/OpenMetadata/issues/12110#issuecomment-1611341650).
+
+{% /note %}
+
 ## Troubleshooting
 
 ### Java Memory Heap Issue