mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-12 03:29:53 +00:00

Pere Miquel Brull c24b4e0178

DOCS - Publish 1.4 docs & Remove 1.1 and 1.2 (#16308 )

2024-05-16 16:10:54 +02:00

1.8 KiB

Raw Blame History

title	slug
Run Data Insights using Metadata CLI	/how-to-guides/data-insights/metadata-cli

Run Data Insights using Metadata CLI

1. Define the YAML Config

This is a sample config for Data Insights:

source:
  type: dataInsight
  serviceName: OpenMetadata
  sourceConfig:
    config:
      type: MetadataToElasticSearch
processor:
  type: data-insight-processor
  config: {}
sink:
  type: elasticsearch
  config:
    es_host: localhost
    es_port: 9200
    recreate_indexes: false
workflowConfig:
  loggerLevel: DEBUG
  openMetadataServerConfig:
    hostPort: '<OpenMetadata host and port>'
    authProvider: openmetadata
    securityConfig:
      jwtToken: '{bot_jwt_token}'

Source Configuration - Source Config

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

Processor Configuration

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

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: openmetadata
    securityConfig:
      jwtToken: '{bot_jwt_token}'

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

2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

metadata insight -c <path-to-yaml>

1.8 KiB Raw Blame History