connectors

No menu items for this category
Home/Connectors/Dashboard/Superset
Superset
Superset
PROD
Available In
Feature List
Dashboards
Charts
Lineage
Owners
Datamodels
Column Lineage
Tags
Projects

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:

Ingestion Deployment

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 you want to install it manually in an already existing Airflow host, you can follow this guide.

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator externally.

Run Connectors from the OpenMetadata UI

Learn how to manage your deployment to run connectors from the UI

Run the Connector Externally

Get the YAML to run the ingestion externally

External Schedulers

Get more information about running the Ingestion Framework Externally

Requirements

The ingestion also works with Superset 2.0.0 🎉

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.

Metadata Ingestion

1. Visit the Services Page

The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first.

This Service will be the bridge between OpenMetadata and your source system.

Once a Service is created, it can be used to configure your ingestion workflows.

Visit Services Page

Select your Service Type and Add a New Service

2. Create a New Service

Click on Add New Service to start the Service creation.

Create a new Service

Add a new Service from the Services page

3. Select the Service Type

Select Superset as the Service type and click Next.

Select Service

Select your Service from the list

4. Name and Describe your Service

Provide a name and description for your Service.

Service Name

OpenMetadata uniquely identifies Services by their Service Name. Provide a name that distinguishes your deployment from other Services, including the other Superset Services that you might be ingesting metadata from.

Note that when the name is set, it cannot be changed.

Add New Service

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for Superset.

Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.

Configure Service connection

Configure the Service connection by filling the form

Connection Details

  • Host and Port: 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.

  • Superset 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.

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

  • Verify SSL: Client SSL verification. Make sure to configure the SSLConfig if enabled. Possible values:

    • validate: Validate the certificate using the public certificate (recommended).
    • ignore: Ignore the certification validation (not recommended for production).
    • no-ssl: SSL validation is not needed.

  • SSL Config: Client SSL configuration in case we are connection to a host with SSL enabled.

  • Certificate Path: CA certificate path in the instance where the ingestion run. E.g., /path/to/public.cert. Will be used if Verify SSL is set to validate.

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.
  • 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.
  • 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).

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme.

This would only be required to handle advanced connectivity scenarios or customizations.

  • Connection Options (Optional): Enter the details for any additional connection options that can be sent to database 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 during the connection. These details must be added as Key-Value pairs.
Advanced Configuration

Advanced Configuration

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

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme.

This would only be required to handle advanced connectivity scenarios or customizations.

  • Connection Options (Optional): Enter the details for any additional connection options that can be sent to database 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 during the connection. These details must be added as Key-Value pairs.
Advanced Configuration

Advanced Configuration

6. Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.

Test Connection

Test the connection and save the Service

7. Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Configure Metadata Ingestion

Configure Metadata Ingestion Page

Metadata Ingestion Options

  • Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
  • Dashboard Filter Pattern (Optional): Use it to control whether to include dashboard as part of metadata ingestion.
    • Include: Explicitly include dashboards by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
    • Exclude: Explicitly exclude dashboards by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
  • Chart Pattern (Optional): Use it to control whether to include charts as part of metadata ingestion.
    • Include: Explicitly include charts by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
    • Exclude: Explicitly exclude charts by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
  • Data Model Pattern (Optional): Use it to control whether to include data modes as part of metadata ingestion.
    • Include: Explicitly include data models by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
    • Exclude: Explicitly exclude data models by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models will be included.
  • Database Service Name (Optional): Enter the name of Database Service which is already ingested in OpenMetadata to create lineage between dashboards and database tables.
  • Enable Debug Log (toggle): Set the 'Enable Debug Log' toggle to set the default log level to debug.
  • Include Owners (toggle): 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.
  • Include Tags (toggle): Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
  • Include Data Models (toggle): Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
  • Mark Deleted Dashboards (toggle): 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.

8. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

After configuring the workflow, you can click on Deploy to create the pipeline.

Schedule the Workflow

Schedule the Ingestion Pipeline and Deploy

9. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View Ingestion Pipeline

View the Ingestion Pipeline from the Service Page

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.
Supertset API SSL Configuration

SSL Configuration

  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.
MySQL SSL Configuration

SSL Configuration

  1. 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.
Postgres SSL Configuration

SSL Configuration

Troubleshooting

Workflow Deployment Error

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

  • You can then Edit the Ingestion Pipeline and Deploy it again.
  • From the Connection tab, you can also Edit the Service if needed.