From ac06f55bd0846b94af37661d719f0a9be69e0167 Mon Sep 17 00:00:00 2001 From: Pere Miquel Brull Date: Fri, 4 Aug 2023 08:35:33 +0200 Subject: [PATCH] [Docs] - host.docker.internal docs & postgres ingestAllDatabases below db input (#12744) --- .../connections/database/postgresConnection.json | 12 ++++++------ .../ui/public/locales/en-US/Database/AzureSQL.md | 2 +- .../ui/public/locales/en-US/Database/Clickhouse.md | 2 +- .../ui/public/locales/en-US/Database/Databricks.md | 2 +- .../ui/public/locales/en-US/Database/Db2.md | 2 +- .../ui/public/locales/en-US/Database/Druid.md | 2 +- .../ui/public/locales/en-US/Database/Hive.md | 6 +++--- .../ui/public/locales/en-US/Database/Impala.md | 2 +- .../ui/public/locales/en-US/Database/MariaDB.md | 2 +- .../ui/public/locales/en-US/Database/MongoDB.md | 2 +- .../ui/public/locales/en-US/Database/Mssql.md | 2 +- .../ui/public/locales/en-US/Database/Mysql.md | 2 +- .../ui/public/locales/en-US/Database/Oracle.md | 2 +- .../ui/public/locales/en-US/Database/PinotDB.md | 2 +- .../ui/public/locales/en-US/Database/Postgres.md | 2 +- .../ui/public/locales/en-US/Database/Presto.md | 2 +- .../ui/public/locales/en-US/Database/Redshift.md | 2 +- .../ui/public/locales/en-US/Database/SQLite.md | 2 +- .../ui/public/locales/en-US/Database/SapHana.md | 2 +- .../ui/public/locales/en-US/Database/SingleStore.md | 2 +- .../ui/public/locales/en-US/Database/Trino.md | 2 +- .../ui/public/locales/en-US/Database/Vertica.md | 3 +-- 22 files changed, 29 insertions(+), 30 deletions(-) diff --git a/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/postgresConnection.json b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/postgresConnection.json index 5bf6009bb1b..e37c8792624 100644 --- a/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/postgresConnection.json +++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/postgresConnection.json @@ -63,6 +63,12 @@ "description": "Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.", "type": "string" }, + "ingestAllDatabases": { + "title": "Ingest All Databases", + "description": "Ingest data from all databases in Postgres. You can use databaseFilterPattern on top of this.", + "type": "boolean", + "default": false + }, "sslMode": { "title": "SSL Mode", "description": "SSL Mode to connect to postgres database.", @@ -85,12 +91,6 @@ "type": "string", "default": "PostgresPolicyTags" }, - "ingestAllDatabases": { - "title": "Ingest All Databases", - "description": "Ingest data from all databases in Postgres. You can use databaseFilterPattern on top of this.", - "type": "boolean", - "default": false - }, "connectionOptions": { "title": "Connection Options", "$ref": "../connectionBasicType.json#/definitions/connectionOptions" diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/AzureSQL.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/AzureSQL.md index 150602efc13..822a8eedef2 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/AzureSQL.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/AzureSQL.md @@ -43,7 +43,7 @@ $$section This parameter specifies the host and port of the AzureSQL instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `azure-sql-service-name.database.windows.net:1433`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3000` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Clickhouse.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Clickhouse.md index d34a0e26e3a..01e483024a0 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Clickhouse.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Clickhouse.md @@ -58,7 +58,7 @@ $$section This parameter specifies the host and port of the ClickHouse instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3000`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3000` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Databricks.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Databricks.md index a4e84ef3308..d54838b9571 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Databricks.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Databricks.md @@ -29,7 +29,7 @@ $$section ### Host Port $(id="hostPort") This parameter specifies the host and port of the Databricks instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `adb-xyz.azuredatabricks.net:443`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3000` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Db2.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Db2.md index 039f3598696..e8b1f2cb7d4 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Db2.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Db2.md @@ -58,7 +58,7 @@ $$section This parameter specifies the host and port of the Db2 instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:8000`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:8000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:8000` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Druid.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Druid.md index 5e40b9a550e..710158fd873 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Druid.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Druid.md @@ -31,7 +31,7 @@ $$section This parameter specifies the host and port of the Druid instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:8000`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:8000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:8000` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Hive.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Hive.md index 55f29016c6c..24113faf9fa 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Hive.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Hive.md @@ -24,7 +24,7 @@ Password to connect to Hive. This parameter specifies the host and port of the Hive instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `myhivehost:10000`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:10000` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:10000` as the value. ### Auth The auth parameter specifies the authentication method to use when connecting to the Hive server. Possible values are `LDAP`, `NONE`, `CUSTOM`, or `KERBEROS`. If you are using Kerberos authentication, you should set auth to `KERBEROS`. If you are using custom authentication, you should set auth to `CUSTOM` and provide additional options in the `authOptions` parameter. @@ -146,7 +146,7 @@ Find more information about [Source Identity](https://docs.aws.amazon.com/STS/la This parameter specifies the host and port of the Postgres instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:5432`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:5432` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:5432` as the value. ### Database @@ -275,7 +275,7 @@ Find more information about [Source Identity](https://docs.aws.amazon.com/STS/la This parameter specifies the host and port of the MySQL instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3306`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3306` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value. ### Database Name $(id="databaseName") In OpenMetadata, the Database Service hierarchy works as follows: diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Impala.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Impala.md index af9f61d93e0..6ab542aac6e 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Impala.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Impala.md @@ -32,7 +32,7 @@ $$section This parameter specifies the host and port of the Impala instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `myimpalahost:21050`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:21050` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:21050` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MariaDB.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MariaDB.md index a6abde286a4..bbf6fc6737b 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MariaDB.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MariaDB.md @@ -47,7 +47,7 @@ $$section This parameter specifies the host and port of the MariaDB instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3306`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3306` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MongoDB.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MongoDB.md index 52864b5abb2..e2dc4e41fd8 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MongoDB.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/MongoDB.md @@ -35,7 +35,7 @@ $$section This parameter specifies the host and port of the MongoDB instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:27017`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:27017` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:27017` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mssql.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mssql.md index 9460e622894..c3b589d4e84 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mssql.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mssql.md @@ -78,7 +78,7 @@ $$section This parameter specifies the host and port of the MSSQL instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:1433`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:1433` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:1433` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql.md index b4b9e2d7b97..cd32717d6d9 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql.md @@ -155,7 +155,7 @@ $$section This parameter specifies the host and port of the MySQL instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3306`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3306` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md index 66c6c988f3c..cbc77264cd8 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md @@ -63,7 +63,7 @@ $$section This parameter specifies the host and port of the Oracle instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:1521`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:1521` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:1521` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/PinotDB.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/PinotDB.md index a9168dcf12e..0d189a41be1 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/PinotDB.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/PinotDB.md @@ -31,7 +31,7 @@ $$section This parameter specifies the host and port of the PinotDB instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:8099`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:8099` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:8099` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Postgres.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Postgres.md index 0815753d02d..7031983a71b 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Postgres.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Postgres.md @@ -156,7 +156,7 @@ $$section This parameter specifies the host and port of the Postgres instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:5432`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:5432` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:5432` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Presto.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Presto.md index f57baa93b63..acda2867147 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Presto.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Presto.md @@ -34,7 +34,7 @@ $$section This parameter specifies the host and port of the Presto instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:8080`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:8080` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:8080` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Redshift.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Redshift.md index 1bba61c1c3b..6731a372b89 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Redshift.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Redshift.md @@ -45,7 +45,7 @@ $$section ### Host Port $(id="hostPort") This parameter specifies the host and port of the Redshift instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:5439`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:5439` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:5439` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SQLite.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SQLite.md index dda8031e48a..3862ff544f4 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SQLite.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SQLite.md @@ -30,7 +30,7 @@ $$section ### Host Port $(id="hostPort") This parameter specifies the host and port of the SQLite instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3306`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3306` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value. Keep it blank for in-memory databases. $$ diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SapHana.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SapHana.md index 1171bffbbc3..76856e4c6c8 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SapHana.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SapHana.md @@ -47,7 +47,7 @@ $$section This parameter specifies the host and port of the SAP Hana instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:39041`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:39041` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:39041` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SingleStore.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SingleStore.md index 12295a38fdd..31d78dff32b 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SingleStore.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/SingleStore.md @@ -45,7 +45,7 @@ $$section ### Host Port $(id="hostPort") This parameter specifies the host and port of the SingleStore instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:3306`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:3306` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Trino.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Trino.md index bd5065405fa..5b6d13a5a6c 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Trino.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Trino.md @@ -38,7 +38,7 @@ $$section ### Host Port $(id="hostPort") This parameter specifies the host and port of the Trino instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:8080`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:8080` as the value. +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:8080` as the value. $$ $$section diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Vertica.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Vertica.md index 08f66b9dbca..588e8acdc6b 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Vertica.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Vertica.md @@ -72,8 +72,7 @@ $$section This parameter specifies the host and port of the Vertica instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:5433`. -If your database service and Open Metadata are both running via docker locally, use `host.docker.internal:5433` as the value. - +If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:5433` as the value. $$ $$section