Doc: Adding SSL Docs for Messaging & Dashboard (#17602)

Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
This commit is contained in:
Prajwal214 2024-08-28 07:16:01 +05:30 committed by GitHub
parent d6c5193dd1
commit 749cf7945e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
45 changed files with 562 additions and 79 deletions

View File

@ -17,6 +17,7 @@ Configure and schedule Metabase metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/qliksense/yaml"} /%}
@ -94,4 +95,27 @@ You will have to replace new lines with `\n` and the final private key that you
{% /stepsContainer %}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value. Navigate to the `Advanced Config` section.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate`. If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`, and `SSL Key`.
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
{% image
src="/images/v1.4/connectors/ssl_qlik_1.png"
alt="SSL Configuration by local file path"
height="450px"
caption="SSL Configuration by local file path" /%}
{% image
src="/images/v1.4/connectors/ssl_qlik_2.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule PowerBI metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
@ -195,4 +196,29 @@ source:
{% /codePreview %}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate` (rootCertificateData). If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`(clientCertificate), and `SSL Key`(clientKeyCertificate).
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
```yaml
certificates:
# pass certificate paths
clientCertificate: /path/to/client.pem
clientKeyCertificate: /path/to/client_key.pem
rootCertificate: /path/to/root.pem
```
```yaml
# pass certificate values
clientCertificateData: -----BEGIN CERTIFICATE-----\n....\n.....\n-----END CERTIFICATE-----\n
clientKeyCertificateData: -----BEGIN RSA PRIVATE KEY-----\n....\n....\n-----END RSA PRIVATE KEY-----\n
rootCertificateData: -----BEGIN CERTIFICATE-----\n....\n...-----END CERTIFICATE-----\n
```
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/superset/yaml"} /%}
@ -78,7 +79,10 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **Username**: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata. Make sure the user has select privileges on `dashboards`, `tables` & `slices` tables of superset schema.
- **Password**: Password to connect to MySQL.
- **Host and Port**: Enter the fully qualified hostname and port number for your MySQL deployment in the Host and Port field.
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **databaseSchema**: Enter the database schema which is associated with the Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
{% partial file="/v1.4/connectors/database/advanced-configuration.md" /%}
@ -90,6 +94,7 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **Password**: Password to connect to Postgres.
- **Host and Port**: Enter the fully qualified hostname and port number for your Postgres deployment in the Host and Port field.
- **Database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
{% partial file="/v1.4/connectors/database/advanced-configuration.md" /%}
@ -103,4 +108,30 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
{% /stepsContainer %}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}
## Securing Superset Connection with SSL in OpenMetadata
1. To establish secure connections between OpenMetadata and Superset, navigate to the `Advanced Config` section. We need to update the `Certificate Path` and ensure that the certificates are accessible from the Airflow Server.
{% image
src="/images/v1.4/connectors/ssl_superset.png"
alt="Supertset API SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.4/connectors/ssl_superset_mysql.png"
alt="MySQL SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
3. To establish secure connections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
{% image
src="/images/v1.4/connectors/ssl_superset_postgres.png"
alt="Postgres SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
@ -98,6 +99,12 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
@ -120,6 +127,8 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
@ -185,6 +194,33 @@ source:
{% /codePreview %}
## Securing Superset Connection with SSL in OpenMetadata
1. To establish secure connections between OpenMetadata and Superset, in the `YAML` under `sslConfig`, we need to add `caCertificate` and update the certificate path. Ensure that the certificates are accessible from the Airflow Server.
```yaml
sslConfig:
caCertificate: /path/to/cacert.crt
```
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
```yaml
type: Mysql
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
3. To establish secure connxxwections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
```yaml
type: Postgres
sslMode: disable #allow prefer require verify-ca verify-full
sslConfig:
caCertificate: "/path/to/ca/certificate"
```
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}

View File

@ -18,6 +18,7 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/tableau/yaml"} /%}
@ -100,4 +101,14 @@ For more information to get a Personal Access Token please visit this [link](htt
{% /stepsContainer %}
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.4/connectors/ssl_tableau.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
@ -314,6 +315,15 @@ workflowConfig:
hostPort: <OpenMetadata host and port>
authProvider: <OpenMetadata auth provider>
```
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/messaging/kafka/yaml"} /%}
@ -67,4 +68,14 @@ To ingest the topic schema `Schema Registry URL` must be passed
{% /stepsContainer %}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.4/connectors/ssl_kafka.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
@ -170,4 +171,15 @@ source:
{% /codePreview %}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Metabase metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/qliksense/yaml"} /%}
@ -94,4 +95,27 @@ You will have to replace new lines with `\n` and the final private key that you
{% /stepsContainer %}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value. Navigate to the `Advanced Config` section.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate`. If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`, and `SSL Key`.
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
{% image
src="/images/v1.5/connectors/ssl_qlik_1.png"
alt="SSL Configuration by local file path"
height="450px"
caption="SSL Configuration by local file path" /%}
{% image
src="/images/v1.5/connectors/ssl_qlik_2.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule PowerBI metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
@ -195,4 +196,29 @@ source:
{% /codePreview %}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate` (rootCertificateData). If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`(clientCertificate), and `SSL Key`(clientKeyCertificate).
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
```yaml
certificates:
# pass certificate paths
clientCertificate: /path/to/client.pem
clientKeyCertificate: /path/to/client_key.pem
rootCertificate: /path/to/root.pem
```
```yaml
# pass certificate values
clientCertificateData: -----BEGIN CERTIFICATE-----\n....\n.....\n-----END CERTIFICATE-----\n
clientKeyCertificateData: -----BEGIN RSA PRIVATE KEY-----\n....\n....\n-----END RSA PRIVATE KEY-----\n
rootCertificateData: -----BEGIN CERTIFICATE-----\n....\n...-----END CERTIFICATE-----\n
```
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/superset/yaml"} /%}
@ -78,7 +79,10 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **Username**: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata. Make sure the user has select privileges on `dashboards`, `tables` & `slices` tables of superset schema.
- **Password**: Password to connect to MySQL.
- **Host and Port**: Enter the fully qualified hostname and port number for your MySQL deployment in the Host and Port field.
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **databaseSchema**: Enter the database schema which is associated with the Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}
@ -90,6 +94,7 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **Password**: Password to connect to Postgres.
- **Host and Port**: Enter the fully qualified hostname and port number for your Postgres deployment in the Host and Port field.
- **Database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}
@ -103,4 +108,30 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
{% /stepsContainer %}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
## Securing Superset Connection with SSL in OpenMetadata
1. To establish secure connections between OpenMetadata and Superset, navigate to the `Advanced Config` section. We need to update the `Certificate Path` and ensure that the certificates are accessible from the Airflow Server.
{% image
src="/images/v1.5/connectors/ssl_superset.png"
alt="Supertset API SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.5/connectors/ssl_superset_mysql.png"
alt="MySQL SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
3. To establish secure connections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
{% image
src="/images/v1.5/connectors/ssl_superset_postgres.png"
alt="Postgres SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
@ -98,6 +99,12 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
@ -120,6 +127,8 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
@ -185,6 +194,33 @@ source:
{% /codePreview %}
## Securing Superset Connection with SSL in OpenMetadata
1. To establish secure connections between OpenMetadata and Superset, in the `YAML` under `sslConfig`, we need to add `caCertificate` and update the certificate path. Ensure that the certificates are accessible from the Airflow Server.
```yaml
sslConfig:
caCertificate: /path/to/cacert.crt
```
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
```yaml
type: Mysql
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
3. To establish secure connxxwections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
```yaml
type: Postgres
sslMode: disable #allow prefer require verify-ca verify-full
sslConfig:
caCertificate: "/path/to/ca/certificate"
```
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -18,6 +18,7 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/tableau/yaml"} /%}
@ -100,4 +101,14 @@ For more information to get a Personal Access Token please visit this [link](htt
{% /stepsContainer %}
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.5/connectors/ssl_tableau.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
@ -314,6 +315,15 @@ workflowConfig:
hostPort: <OpenMetadata host and port>
authProvider: <OpenMetadata auth provider>
```
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/messaging/kafka/yaml"} /%}
@ -67,4 +68,14 @@ To ingest the topic schema `Schema Registry URL` must be passed
{% /stepsContainer %}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.5/connectors/ssl_kafka.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}

View File

@ -17,6 +17,7 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
@ -170,4 +171,15 @@ source:
{% /codePreview %}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,8 +17,9 @@ Configure and schedule Metabase metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/qliksense/yaml"} /%}
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/qliksense/yaml"} /%}
## Requirements
@ -29,12 +30,12 @@ To deploy OpenMetadata, check the Deployment guides.
## Metadata Ingestion
{% partial
file="/v1.5/connectors/metadata-ingestion-ui.md"
file="/v1.6/connectors/metadata-ingestion-ui.md"
variables={
connector: "QlikSense",
selectServicePath: "/images/v1.5/connectors/qliksense/select-service.png",
addNewServicePath: "/images/v1.5/connectors/qliksense/add-new-service.png",
serviceConnectionPath: "/images/v1.5/connectors/qliksense/service-connection.png",
selectServicePath: "/images/v1.6/connectors/qliksense/select-service.png",
addNewServicePath: "/images/v1.6/connectors/qliksense/add-new-service.png",
serviceConnectionPath: "/images/v1.6/connectors/qliksense/service-connection.png",
}
/%}
@ -86,12 +87,35 @@ You will have to replace new lines with `\n` and the final private key that you
{% /extraContent %}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.6/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value. Navigate to the `Advanced Config` section.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate`. If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`, and `SSL Key`.
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
{% image
src="/images/v1.6/connectors/ssl_qlik_1.png"
alt="SSL Configuration by local file path"
height="450px"
caption="SSL Configuration by local file path" /%}
{% image
src="/images/v1.6/connectors/ssl_qlik_2.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.6/connectors/troubleshooting.md" /%}

View File

@ -17,14 +17,15 @@ Configure and schedule PowerBI metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-qlik-sense-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
## Requirements
### Python Requirements
{% partial file="/v1.5/connectors/python-requirements.md" /%}
{% partial file="/v1.6/connectors/python-requirements.md" /%}
To run the PowerBI ingestion, you will need to install:
@ -138,11 +139,11 @@ You will have to replace new lines with `\n` and the final private key that you
{% /codeInfo %}
{% partial file="/v1.5/connectors/yaml/dashboard/source-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -185,14 +186,39 @@ source:
```yaml {% srNumber=6 %}
validateHostName: false
```
{% partial file="/v1.5/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
## Securing Qlik Sense Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value.
When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the `client certificate`, `client key certificate`, and `root certificate`.
Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the `CA Certificate` (rootCertificateData). If both client and server require mutual authentication, you can upload all three: `CA Certificate`, `SSL Certificate`(clientCertificate), and `SSL Key`(clientKeyCertificate).
Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense [here](/connectors/dashboard/qliksense/certificates).
```yaml
certificates:
# pass certificate paths
clientCertificate: /path/to/client.pem
clientKeyCertificate: /path/to/client_key.pem
rootCertificate: /path/to/root.pem
```
```yaml
# pass certificate values
clientCertificateData: -----BEGIN CERTIFICATE-----\n....\n.....\n-----END CERTIFICATE-----\n
clientKeyCertificateData: -----BEGIN RSA PRIVATE KEY-----\n....\n....\n-----END RSA PRIVATE KEY-----\n
rootCertificateData: -----BEGIN CERTIFICATE-----\n....\n...-----END CERTIFICATE-----\n
```
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,8 +17,9 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/superset/yaml"} /%}
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/superset/yaml"} /%}
## Requirements
@ -31,12 +32,12 @@ The ingestion also works with Superset 2.0.0 🎉
## Metadata Ingestion
{% partial
file="/v1.5/connectors/metadata-ingestion-ui.md"
file="/v1.6/connectors/metadata-ingestion-ui.md"
variables={
connector: "Superset",
selectServicePath: "/images/v1.5/connectors/superset/select-service.png",
addNewServicePath: "/images/v1.5/connectors/superset/add-new-service.png",
serviceConnectionPath: "/images/v1.5/connectors/superset/service-connection.png",
selectServicePath: "/images/v1.6/connectors/superset/select-service.png",
addNewServicePath: "/images/v1.6/connectors/superset/add-new-service.png",
serviceConnectionPath: "/images/v1.6/connectors/superset/service-connection.png",
}
/%}
@ -78,9 +79,12 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **Username**: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata. Make sure the user has select privileges on `dashboards`, `tables` & `slices` tables of superset schema.
- **Password**: Password to connect to MySQL.
- **Host and Port**: Enter the fully qualified hostname and port number for your MySQL deployment in the Host and Port field.
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **databaseSchema**: Enter the database schema which is associated with the Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}
{% partial file="/v1.6/connectors/database/advanced-configuration.md" /%}
#### For Postgres Connection
@ -90,17 +94,44 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **Password**: Password to connect to Postgres.
- **Host and Port**: Enter the fully qualified hostname and port number for your Postgres deployment in the Host and Port field.
- **Database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}
{% partial file="/v1.6/connectors/database/advanced-configuration.md" /%}
{% /extraContent %}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.6/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
## Securing Superset Connection with SSL in OpenMetadata
1. To establish secure connections between OpenMetadata and Superset, navigate to the `Advanced Config` section. We need to update the `Certificate Path` and ensure that the certificates are accessible from the Airflow Server.
{% image
src="/images/v1.6/connectors/ssl_superset.png"
alt="Supertset API SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.6/connectors/ssl_superset_mysql.png"
alt="MySQL SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
3. To establish secure connections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
{% image
src="/images/v1.6/connectors/ssl_superset_postgres.png"
alt="Postgres SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.6/connectors/troubleshooting.md" /%}

View File

@ -17,8 +17,9 @@ Configure and schedule Superset metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-superset-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
## Requirements
@ -32,7 +33,7 @@ The ingestion also works with Superset 2.0.0 🎉
### Python Requirements
{% partial file="/v1.5/connectors/python-requirements.md" /%}
{% partial file="/v1.6/connectors/python-requirements.md" /%}
To run the Superset ingestion, you will need to install:
@ -98,6 +99,12 @@ You can use Mysql Connection when you have SSO enabled and your Superset is back
- **databaseSchema**: Enter the database schema which is associated with the Superset instance..
- **caCertificate**: Provide the path to ssl ca file.
- **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert).
- **sslKey**: Provide the path to ssl client certificate file (ssl_key).
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to MySQL during the connection. These details must be added as Key-Value pairs.
@ -120,6 +127,8 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
- **database**: Initial Postgres database to connect to. Specify the name of database associated with Superset instance.
- **caCertificate**: Provide the path to ssl ca file.
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Postgres during the connection. These details must be added as Key-Value pairs.
@ -128,11 +137,11 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b
{% /codeInfo %}
{% partial file="/v1.5/connectors/yaml/dashboard/source-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -175,16 +184,43 @@ source:
# database: superset
```
{% partial file="/v1.5/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}
## Securing Superset Connection with SSL in OpenMetadata
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
1. To establish secure connections between OpenMetadata and Superset, in the `YAML` under `sslConfig`, we need to add `caCertificate` and update the certificate path. Ensure that the certificates are accessible from the Airflow Server.
```yaml
sslConfig:
caCertificate: /path/to/cacert.crt
```
2. To establish secure connections between OpenMetadata and Superset's MySQL database, you need to configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, you must provide all three parameters: `ssl_key` for the clients private key, `ssl_cert` for the clients SSL certificate, and `ssl_ca` for the CA certificate to validate the servers certificate.
```yaml
type: Mysql
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
3. To establish secure connxxwections between OpenMetadata and Superset's PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.
```yaml
type: Postgres
sslMode: disable #allow prefer require verify-ca verify-full
sslConfig:
caCertificate: "/path/to/ca/certificate"
```
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}

View File

@ -18,8 +18,9 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/tableau/yaml"} /%}
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/tableau/yaml"} /%}
## Requirements
@ -31,12 +32,12 @@ For more information on enabling the Tableau Metadata APIs follow the link [here
## Metadata Ingestion
{% partial
file="/v1.5/connectors/metadata-ingestion-ui.md"
file="/v1.6/connectors/metadata-ingestion-ui.md"
variables={
connector: "Tableau",
selectServicePath: "/images/v1.5/connectors/tableau/select-service.png",
addNewServicePath: "/images/v1.5/connectors/tableau/add-new-service.png",
serviceConnectionPath: "/images/v1.5/connectors/tableau/service-connection.png",
selectServicePath: "/images/v1.6/connectors/tableau/select-service.png",
addNewServicePath: "/images/v1.6/connectors/tableau/add-new-service.png",
serviceConnectionPath: "/images/v1.6/connectors/tableau/service-connection.png",
}
/%}
@ -92,12 +93,22 @@ For more information to get a Personal Access Token please visit this [link](htt
{% /extraContent %}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.6/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.6/connectors/ssl_tableau.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.6/connectors/troubleshooting.md" /%}

View File

@ -17,8 +17,9 @@ Configure and schedule Tableau metadata and profiler workflows from the OpenMeta
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-tableau-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
## Requirements
@ -29,7 +30,7 @@ For more information on enabling the Tableau Metadata APIs follow the link [here
### Python Requirements
{% partial file="/v1.5/connectors/python-requirements.md" /%}
{% partial file="/v1.6/connectors/python-requirements.md" /%}
To run the Tableau ingestion, you will need to install:
@ -140,7 +141,7 @@ To send the metadata to OpenMetadata, it needs to be specified as `type: metadat
{% /codeInfo %}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -183,11 +184,11 @@ source:
paginationLimit: pagination_limit
```
{% partial file="/v1.5/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
@ -314,6 +315,15 @@ workflowConfig:
hostPort: <OpenMetadata host and port>
authProvider: <OpenMetadata auth provider>
```
## Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}

View File

@ -17,8 +17,9 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/messaging/kafka/yaml"} /%}
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/messaging/kafka/yaml"} /%}
## Requirements
@ -29,12 +30,12 @@ The ingestion of the Kafka topics' schema is done separately by configuring the
## Metadata Ingestion
{% partial
file="/v1.5/connectors/metadata-ingestion-ui.md"
file="/v1.6/connectors/metadata-ingestion-ui.md"
variables={
connector: "Kafka",
selectServicePath: "/images/v1.5/connectors/kafka/select-service.png",
addNewServicePath: "/images/v1.5/connectors/kafka/add-new-service.png",
serviceConnectionPath: "/images/v1.5/connectors/kafka/service-connection.png",
selectServicePath: "/images/v1.6/connectors/kafka/select-service.png",
addNewServicePath: "/images/v1.6/connectors/kafka/add-new-service.png",
serviceConnectionPath: "/images/v1.6/connectors/kafka/service-connection.png",
}
/%}
@ -59,12 +60,22 @@ To ingest the topic schema `Schema Registry URL` must be passed
{% /extraContent %}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.6/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/messaging/configure-ingestion.md" /%}
{% partial file="/v1.6/connectors/messaging/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
{% image
src="/images/v1.6/connectors/ssl_kafka.png"
alt="SSL Configuration"
height="450px"
caption="SSL Configuration" /%}
{% partial file="/v1.6/connectors/troubleshooting.md" /%}

View File

@ -17,14 +17,15 @@ Configure and schedule Kafka metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Enable Security](#securing-kafka-connection-with-ssl-in-openmetadata)
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
## Requirements
### Python Requirements
{% partial file="/v1.5/connectors/python-requirements.md" /%}
{% partial file="/v1.6/connectors/python-requirements.md" /%}
To run the Kafka ingestion, you will need to install:
@ -117,11 +118,11 @@ following [link](https://docs.confluent.io/5.5.1/clients/confluent-kafka-python/
{% /codeInfo %}
{% partial file="/v1.5/connectors/yaml/messaging/source-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/messaging/source-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -160,14 +161,25 @@ source:
schemaRegistryConfig: {}
```
{% partial file="/v1.5/connectors/yaml/messaging/source-config.md" /%}
{% partial file="/v1.6/connectors/yaml/messaging/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
## Securing Kafka Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Kafka, in the `YAML` you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl key`, `ssl cert`, and `caCertificate`. In this case, `ssl_cert` is used for the clients SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `caCertificate` for the CA certificate to validate the servers certificate.
```yaml
sslConfig:
caCertificate: "/path/to/ca_certificate"
sslCertificate: "/path/to/your/ssl_cert"
sslKey: "/path/to/your/ssl_key"
```
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB