yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-04 07:33:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Cluster Allias Configuration update (#21171)

Browse Source
This commit is contained in:
Rounak Dhillon 2025-05-13 19:23:00 +05:30 committed by GitHub
parent 50a798dd2d
commit d4d1a16eaf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 49 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
openmetadata-docs/content/v1.6.x/deployment/bare-metal/index.md
View File

@ -220,6 +220,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com' ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com'
ELASTICSEARCH_PASSWORD='<ES_PASSWORD>' ELASTICSEARCH_PASSWORD='<ES_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
### Configure OpenSearch ### Configure OpenSearch
@ -231,9 +232,15 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
### Configure Ingestion ### Configure Ingestion
``` ```

11
openmetadata-docs/content/v1.6.x/deployment/docker/index.md
View File

@ -123,7 +123,6 @@ DB_USER_PASSWORD="<SQL_DATABASE_PASSWORD>"
DB_HOST="<SQL_DATABASE_ENDPOINT>" DB_HOST="<SQL_DATABASE_ENDPOINT>"
DB_PORT="<SQL_DATABASE_PORT>" DB_PORT="<SQL_DATABASE_PORT>"
OM_DATABASE="<SQL_DATABASE_NAME>" OM_DATABASE="<SQL_DATABASE_NAME>"
...
``` ```
For ElasticSearch Configurations, update the below environment variables - For ElasticSearch Configurations, update the below environment variables -
@ -136,7 +135,7 @@ ELASTICSEARCH_PORT="<ELASTICSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>" ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
For OpenSearch Configurations, update the below environment variables - For OpenSearch Configurations, update the below environment variables -
@ -149,8 +148,13 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
For Ingestion Configurations, update the below environment variables - For Ingestion Configurations, update the below environment variables -
@ -273,6 +277,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>' ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>'
ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>' ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command. Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command.

8
openmetadata-docs/content/v1.7.x/deployment/bare-metal/index.md
View File

@ -220,6 +220,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com' ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com'
ELASTICSEARCH_PASSWORD='<ES_PASSWORD>' ELASTICSEARCH_PASSWORD='<ES_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
### Configure OpenSearch ### Configure OpenSearch
@ -231,8 +232,13 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
### Configure Ingestion ### Configure Ingestion

12
openmetadata-docs/content/v1.7.x/deployment/docker/index.md
View File

@ -123,7 +123,6 @@ DB_USER_PASSWORD="<SQL_DATABASE_PASSWORD>"
DB_HOST="<SQL_DATABASE_ENDPOINT>" DB_HOST="<SQL_DATABASE_ENDPOINT>"
DB_PORT="<SQL_DATABASE_PORT>" DB_PORT="<SQL_DATABASE_PORT>"
OM_DATABASE="<SQL_DATABASE_NAME>" OM_DATABASE="<SQL_DATABASE_NAME>"
...
``` ```
For ElasticSearch Configurations, update the below environment variables - For ElasticSearch Configurations, update the below environment variables -
@ -136,7 +135,7 @@ ELASTICSEARCH_PORT="<ELASTICSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>" ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
For OpenSearch Configurations, update the below environment variables - For OpenSearch Configurations, update the below environment variables -
@ -149,9 +148,15 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
For Ingestion Configurations, update the below environment variables - For Ingestion Configurations, update the below environment variables -
```bash ```bash
@ -273,6 +278,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>' ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>'
ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>' ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command. Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command.

9
openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/bare-metal/index.md
View File

@ -220,6 +220,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com' ELASTICSEARCH_HOST='vpc-<random_characters>.<aws_region>.es.amazonaws.com'
ELASTICSEARCH_PASSWORD='<ES_PASSWORD>' ELASTICSEARCH_PASSWORD='<ES_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
### Configure OpenSearch ### Configure OpenSearch
@ -231,9 +232,15 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
### Configure Ingestion ### Configure Ingestion
``` ```

12
openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/docker/index.md
View File

@ -123,7 +123,6 @@ DB_USER_PASSWORD="<SQL_DATABASE_PASSWORD>"
DB_HOST="<SQL_DATABASE_ENDPOINT>" DB_HOST="<SQL_DATABASE_ENDPOINT>"
DB_PORT="<SQL_DATABASE_PORT>" DB_PORT="<SQL_DATABASE_PORT>"
OM_DATABASE="<SQL_DATABASE_NAME>" OM_DATABASE="<SQL_DATABASE_NAME>"
...
``` ```
For ElasticSearch Configurations, update the below environment variables - For ElasticSearch Configurations, update the below environment variables -
@ -136,7 +135,7 @@ ELASTICSEARCH_PORT="<ELASTICSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<ELASTICSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>" ELASTICSEARCH_USER="<ELASTICSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<ELASTICSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
For OpenSearch Configurations, update the below environment variables - For OpenSearch Configurations, update the below environment variables -
@ -149,9 +148,15 @@ ELASTICSEARCH_PORT="<OPENSEARCH_ENDPOINT_PORT>"
ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>" ELASTICSEARCH_SCHEME="<OPENSEARCH_ENDPOINT_SCHEME>"
ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>" ELASTICSEARCH_USER="<OPENSEARCH_USERNAME>"
ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>" ELASTICSEARCH_PASSWORD="<OPENSEARCH_PASSWORD>"
... ELASTICSEARCH_CLUSTER_ALIAS="<clusterAlias>"
``` ```
{% note %}
If you want to separate indexes for production and non-production environments, you can set the `clusterAlias` in the configuration file.
{% /note %}
For Ingestion Configurations, update the below environment variables - For Ingestion Configurations, update the below environment variables -
```bash ```bash
@ -273,6 +278,7 @@ ELASTICSEARCH_SCHEME='https'
ELASTICSEARCH_BATCH_SIZE='10' ELASTICSEARCH_BATCH_SIZE='10'
ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>' ELASTICSEARCH_HOST='<ELASTICSEARCH_HOST_URL>'
ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>' ELASTICSEARCH_PASSWORD='<ELASTICSEARCH_PASSWORD>'
ELASTICSEARCH_CLUSTER_ALIAS='<clusterAlias>'
``` ```
Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command. Replace the environment variables values with the RDS and OpenSearch Service ones and then provide this environment variable file as part of docker compose command.