Run Superset using the metadata CLI

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:

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.

The ingestion also works with Superset 2.0.0 🎉

To run the Superset ingestion, you will need to install:

pip3 install "openmetadata-ingestion[superset]"

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

This is a sample config for Superset:

source:
  type: superset
  serviceName: local_superset
  serviceConnection:
    config:
      type: Superset
      hostPort: http://localhost:8080
      username: admin
      password: admin
      # provider: db (default)
  sourceConfig:
    config:
      type: DashboardMetadata
      # dbServiceNames:
      #   - service1
      #   - service2
      # dashboardFilterPattern:
      #   includes:
      #     - dashboard1
      #     - dashboard2
      #   excludes:
      #     - dashboard3
      #     - dashboard4
      # chartFilterPattern:
      #   includes:
      #     - chart1
      #     - chart2
      #   excludes:
      #     - chart3
      #     - chart4
sink:
  type: metadata-rest
  config: {}
workflowConfig:
  # loggerLevel: DEBUG  # DEBUG, INFO, WARN or ERROR
  openMetadataServerConfig:
    hostPort: http://localhost:8585/api
    authProvider: no-auth

Source Configuration - Service Connection

  • hostPort: URL to the Superset instance.
  • username: Specify the User to connect to Superset. It should have enough privileges to read all the metadata.
  • password: Password for Superset.
  • provider: Authentication provider for the Superset service. For basic user/password authentication, the default value db can be used. This parameter is used internally to connect to Superset's REST API.

Source Configuration - Source Config

The sourceConfig is defined here:

  • dbServiceName: Database Service Name for the creation of lineage, if the source supports it.
  • dashboardFilterPattern and chartFilterPattern: Note that the dashboardFilterPattern and chartFilterPattern both support regex as include or exclude. E.g.,
dashboardFilterPattern:
  includes:
    - users
    - type_test

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.

For a simple, local installation using our docker containers, this looks like:

workflowConfig:
  openMetadataServerConfig:
    hostPort: http://localhost:8585/api
    authProvider: no-auth

We support different security providers. You can find their definitions here. You can find the different implementation of the ingestion below.

chevron_rightConfigure SSO in the Ingestion Workflows

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.

Still have questions?

You can take a look at our Q&A or reach out to us in Slack

Was this page helpful?

editSuggest edits