OpenMetadata/openmetadata-docs/content/v1.0.0/connectors/dashboard/mode/cli.md

title	slug
Run Mode Connector using the CLI	/connectors/dashboard/mode/cli

Run Mode using the metadata CLI

Stage	PROD
Dashboards	{% icon iconName="check" /%}
Charts	{% icon iconName="check" /%}
Owners	{% icon iconName="cross" /%}
Tags	{% icon iconName="cross" /%}
Datamodels	{% icon iconName="cross" /%}
Lineage	{% icon iconName="check" /%}

In this section, we provide guides and references to use the Mode connector.

Configure and schedule Mode metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

Requirements

{%inlineCallout icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"%} To deploy OpenMetadata, check the Deployment guides. {%/inlineCallout%}

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.

OpenMetadata relies on Mode's API, which is exclusive to members of the Mode Business Workspace. This means that only resources that belong to a Mode Business Workspace can be accessed via the API.

Python Requirements

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

pip3 install "openmetadata-ingestion[mode]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Mode.

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

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

hostPort: Host and Port Mode Dashboard.

The hostPort parameter specifies the host and port of the Mode server. This should be specified as a string in the format https://app.mode.com.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

accessToken: Access Token for Mode Dashboard.

Get the Access Token by following below mentioned steps:

• Navigate to your Mode homepage.
• Click on your name in the upper left corner and click My Account.
• Click on API Tokens on the left side.
• To generate a new API token and password, enter a token name and click Create token.
• Copy the generated access token and password.

For detailed information visit here.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

accessTokenPassword: Access Token Password for Mode Dashboard.

Copy the access token password from the step above where a new token is generated.

For detailed information visit here.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

workspaceName: Mode Workspace Name.

Name of the mode workspace from where the metadata is to be fetched.

{% /codeInfo %}

Source Configuration - Source Config

{% codeInfo srNumber=5 %}

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

{% /codeInfo %}

Sink Configuration

{% codeInfo srNumber=6 %}

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

{% /codeInfo %}

Workflow Configuration

{% codeInfo srNumber=7 %}

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:

{% /codeInfo %}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: mode
  serviceName: local_mode
  serviceConnection:
    config:
      type: Mode

      hostPort: https://app.mode.com

      access_token: access_token

      access_token_password: access_token_password

      workspace_name: workspace_name

  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:
  openMetadataServerConfig:
    hostPort: "http://localhost:8585/api"
    authProvider: openmetadata
    securityConfig:
      jwtToken: "{bot_jwt_token}"

{% /codeBlock %}

{% /codePreview %}

Workflow Configs for Security Provider

We support different security providers. You can find their definitions here.

Openmetadata JWT Auth

• JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

workflowConfig:
  openMetadataServerConfig:
    hostPort: "http://localhost:8585/api"
    authProvider: openmetadata
    securityConfig:
      jwtToken: "{bot_jwt_token}"

• You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration. If you need information on configuring the ingestion with other security providers in your bots, you can follow this doc link.

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.