Skip to main content
Superset

Superset

PROD
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.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
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.9-3.11
To run the Superset ingestion, you will need to install: 
pip3 install "openmetadata-ingestion[superset]"

​
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:

​
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.
    sslConfig:
      caCertificate: /path/to/cacert.crt
  1. 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, and ssl_ca for the CA certificate to validate the server’s certificate.
        type: Mysql
          sslConfig:
            caCertificate: "/path/to/ca_certificate"
            sslCertificate: "/path/to/your/ssl_cert"
            sslKey: "/path/to/your/ssl_key"
  1. 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.
        type: Postgres
          sslMode: disable #allow prefer require verify-ca verify-full
          sslConfig:
            caCertificate: "/path/to/ca/certificate"

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
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.