From a5bf0f19ea59b5c1cffffd3f5d488be1a2a9bb4a Mon Sep 17 00:00:00 2001 From: RounakDhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Thu, 23 Jan 2025 18:05:08 +0530 Subject: [PATCH] Docs: Exasol Connector CHANGES (#19494) Co-authored-by: Rounak Dhillon --- .../connectors/database/exasol/index.md | 38 ++++++++----------- .../v1.6.x/connectors/database/exasol/yaml.md | 22 +++++------ .../connectors/database/exasol/index.md | 38 ++++++++----------- .../connectors/database/exasol/yaml.md | 22 +++++------ 4 files changed, 52 insertions(+), 68 deletions(-) diff --git a/openmetadata-docs/content/v1.6.x/connectors/database/exasol/index.md b/openmetadata-docs/content/v1.6.x/connectors/database/exasol/index.md index 43857987e47..4b26def5851 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/database/exasol/index.md +++ b/openmetadata-docs/content/v1.6.x/connectors/database/exasol/index.md @@ -46,38 +46,30 @@ The connector requires **Exasol version 7.1 or higher** to function correctly. E {% stepsContainer %} {% extraContent parentTagName="stepsContainer" %} -#### Connection Options +### Connection Options -### Connection Scheme -Specifies the SQLAlchemy driver scheme options required to connect to Exasol. +**Connection Scheme**: Specifies the SQLAlchemy driver scheme options required to connect to Exasol. -### Username -The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol. +**Username**: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol. -### Password -The password associated with the user connecting to Exasol. +**Password**: The password associated with the user connecting to Exasol. -### Host and Port -Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example: -- `localhost:8563` +**Host and Port**: Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example: `localhost:8563` - If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`. -### SSL/TLS Settings -Specifies the mode or settings for SSL/TLS validation during the connection. Available options: +**SSL/TLS Settings**: Specifies the mode or settings for SSL/TLS validation during the connection. Available options: -#### validate-certificate (Default) -- Enables Transport Layer Security (TLS). -- Validates the server certificate using system certificate stores. +**validate-certificate (Default)**: Enables Transport Layer Security (TLS) and validates the server certificate using system certificate stores. -#### ignore-certificate -- Enables Transport Layer Security (TLS). -- Disables validation of the server certificate. -- **Note**: This mode should not be used in production. It is useful for testing with self-signed certificates. +**ignore-certificate**: Enables Transport Layer Security (TLS) but disables validation of the server certificate. -#### disable-tls -- Disables Transport Layer Security (TLS). -- Data is sent in plain text (no encryption). -- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios. +{% note %} +This mode should not be used in production. It is useful for testing with self-signed certificates. +{% /note %} + +**disable-tls**: Disables Transport Layer Security (TLS). Data is sent in plain text (no encryption). +[!WARNING] +This mode is not recommended for production and should only be used in debugging scenarios. {% note %} Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements. diff --git a/openmetadata-docs/content/v1.6.x/connectors/database/exasol/yaml.md b/openmetadata-docs/content/v1.6.x/connectors/database/exasol/yaml.md index cd39ec6cb64..b625930e338 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/database/exasol/yaml.md +++ b/openmetadata-docs/content/v1.6.x/connectors/database/exasol/yaml.md @@ -46,6 +46,15 @@ This is a sample config for Exasol: {% codeInfo srNumber=1 %} +**`username`** +The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol. + +**`password`** +The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials. + +**`hostPort`** +Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field. + **`SSL/TLS Settings`** Mode/setting for SSL validation: @@ -56,15 +65,6 @@ Mode/setting for SSL validation: - **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption). While this may be helpful in rare cases of debugging, make sure you do not use this in production. -**`username`** -The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol. - -**`password`** -The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials. - -**`hostPort`** -Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field. - {% /codeInfo %} #### Advanced Configuration @@ -94,10 +94,10 @@ source: type: Exasol ``` ```yaml {% srNumber=1 %} - SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls - hostPort: 127.0.0.1:8563 username: Exasol password: password + hostPort: 127.0.0.1:8563 + SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls ``` ```yaml {% srNumber=2 %} # connectionOptions: diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/index.md index d6b820bd9c7..817d8061b8d 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/index.md @@ -46,38 +46,30 @@ The connector requires **Exasol version 7.1 or higher** to function correctly. E {% stepsContainer %} {% extraContent parentTagName="stepsContainer" %} -#### Connection Options +### Connection Options -### Connection Scheme -Specifies the SQLAlchemy driver scheme options required to connect to Exasol. +**Connection Scheme**: Specifies the SQLAlchemy driver scheme options required to connect to Exasol. -### Username -The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol. +**Username**: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol. -### Password -The password associated with the user connecting to Exasol. +**Password**: The password associated with the user connecting to Exasol. -### Host and Port -Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example: -- `localhost:8563` +**Host and Port**: Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example: `localhost:8563` - If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`. -### SSL/TLS Settings -Specifies the mode or settings for SSL/TLS validation during the connection. Available options: +**SSL/TLS Settings**: Specifies the mode or settings for SSL/TLS validation during the connection. Available options: -#### validate-certificate (Default) -- Enables Transport Layer Security (TLS). -- Validates the server certificate using system certificate stores. +**validate-certificate (Default)**: Enables Transport Layer Security (TLS) and validates the server certificate using system certificate stores. -#### ignore-certificate -- Enables Transport Layer Security (TLS). -- Disables validation of the server certificate. -- **Note**: This mode should not be used in production. It is useful for testing with self-signed certificates. +**ignore-certificate**: Enables Transport Layer Security (TLS) but disables validation of the server certificate. -#### disable-tls -- Disables Transport Layer Security (TLS). -- Data is sent in plain text (no encryption). -- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios. +{% note %} +- This mode should not be used in production. It is useful for testing with self-signed certificates. +{% /note %} + +**disable-tls**: Disables Transport Layer Security (TLS). Data is sent in plain text (no encryption). +[!WARNING] +This mode is not recommended for production and should only be used in debugging scenarios. {% note %} Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements. diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/yaml.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/yaml.md index 4cb1d0696c2..5337973c9a9 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/yaml.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/exasol/yaml.md @@ -46,6 +46,15 @@ This is a sample config for Exasol: {% codeInfo srNumber=1 %} +**`username`** +The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol. + +**`password`** +The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials. + +**`hostPort`** +Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field. + **`SSL/TLS Settings`** Mode/setting for SSL validation: @@ -56,15 +65,6 @@ Mode/setting for SSL validation: - **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption). While this may be helpful in rare cases of debugging, make sure you do not use this in production. -**`username`** -The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol. - -**`password`** -The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials. - -**`hostPort`** -Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field. - {% /codeInfo %} #### Advanced Configuration @@ -94,10 +94,10 @@ source: type: Exasol ``` ```yaml {% srNumber=1 %} - SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls - hostPort: 127.0.0.1:8563 username: Exasol password: password + hostPort: 127.0.0.1:8563 + SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls ``` ```yaml {% srNumber=2 %} # connectionOptions: