![Superset](/_next/image?url=%2Fimages%2Fconnectors%2Fsuperset.webp&w=64&q=75)
In this section, we provide guides and references to use the Superset connector.
Configure and schedule Superset metadata and profiler workflows from the OpenMetadata UI:
How to Run the Connector Externally
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.
Requirements
The ingestion also works with Superset 2.0.0 🎉
Note:
API Connection: To extract metadata from Superset via API, user must have at least can read on Chart
& can read on Dashboard
permissions.
Database Connection: To extract metadata from Superset via MySQL or Postgres database, database user must have at least SELECT
privilege on dashboards
& slices
tables within superset schema.
Python Requirements
We have support for Python versions 3.8-3.11
To run the Superset ingestion, you will need to install:
Metadata Ingestion
All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Superset.
In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.
The workflow is modeled around the following JSON Schema
1. Define the YAML Config
This is a sample config for Superset:
Source Configuration - Service Connection
hostPort: The Host and Post
parameter is common for all three modes of authentication which specifies the host and port of the Superset instance. This should be specified as a string in the format http://hostname:port
or https://hostname:port
. For example, you might set the hostPort parameter to https://org.superset.com:8088
.
connection: Add the connection details to fetch metadata from Superset either through APIs or Database.
For Superset API Connection:
Superset API connection is the default mode of authentication where we fetch the metadata using Superset APIs.
Note: Superset only supports basic or ldap authentication through APIs so if you have SSO enabled on your Superset instance then this mode of authentication will not work for you and you can opt for MySQL or Postgres Connection to fetch metadata directly from the database in the backend of Superset.
username: Username to connect to Superset, for ex. user@organization.com
. This user should have access to relevant dashboards and charts in Superset to fetch the metadata.
password: Password of the user account to connect with Superset.
provider: Choose between db
(default) or ldap
mode of Authentication provider for the Superset service. This parameter is used internally to connect to Superset's REST API.
For MySQL Connection:
You can use Mysql Connection when you have SSO enabled and your Superset is backed by Mysql database.
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.
hostPort: 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..
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.
- In case you are using Single-Sign-On (SSO) for authentication, add the
authenticator
details in the Connection Arguments as a Key-Value pair as follows:"authenticator" : "sso_login_url"
For Postgres Connection:
You can use Postgres Connection when you have SSO enabled and your Superset is backed by Postgres database.
- username: Specify the User to connect to Postgres. Make sure the user has select privileges on
dashboards
,tables
&slices
tables of superset schema.
password: Password to connect to Postgres.
hostPort: 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.
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.
- In case you are using Single-Sign-On (SSO) for authentication, add the
authenticator
details in the Connection Arguments as a Key-Value pair as follows:"authenticator" : "sso_login_url"
Source Configuration - Source Config
The sourceConfig
is defined here:
- dbServiceNames: Database Service Names for ingesting lineage if the source supports it.
- dashboardFilterPattern, chartFilterPattern, dataModelFilterPattern: Note that all of them support regex as include or exclude. E.g., "My dashboard, My dash.*, .*Dashboard".
- projectFilterPattern: Filter the dashboards, charts and data sources by projects. Note that all of them support regex as include or exclude. E.g., "My project, My proj.*, .*Project".
- includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
- includeTags: Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
- includeDataModels: Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
- markDeletedDashboards: Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.
- Include Draft Dashboard (toogle): Set the 'Include Draft Dashboard' toggle to include draft dashboards. By default it will include draft dashboards.
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest
.
Workflow Configuration
The main property here is the openMetadataServerConfig
, where you can define the host and security provider of your OpenMetadata installation.
Logger Level
You can specify the loggerLevel
depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG
will give you far more traces for identifying issues.
JWT Token
JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.
You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.
Store Service Connection
If set to true
(default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false
, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
Store Service Connection
If set to true
(default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false
, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
SSL Configuration
If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL
to ignore
, or have it as validate
, which will require you to set the sslConfig.caCertificate
with a local path where your ingestion runs that points to the server certificate file.
Find more information on how to troubleshoot SSL issues here.
Securing Superset Connection with SSL in OpenMetadata
- To establish secure connections between OpenMetadata and Superset, in the
YAML
undersslConfig
, we need to addcaCertificate
and update the certificate path. Ensure that the certificates are accessible from the Airflow Server.
- 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 client’s private key,ssl_cert
for the client’s SSL certificate, andssl_ca
for the CA certificate to validate the server’s certificate.
- 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 asprefer
,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.
2. Run with the CLI
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.