yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-13 20:18:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.0.0/connectors/dashboard/looker/cli.md
Pere Miquel Brull b60f198674
Fix GitHub reader headers and add docs (#11675) 
* Fix header and add docs

* Format
2023-05-19 09:36:30 +02:00

8.5 KiB
Raw Blame History

title slug
Run Looker Connector using the CLI /connectors/dashboard/looker/cli

Run Looker using the metadata CLI

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

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

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

Requirements

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

There are two types of metadata we ingest from Looker:

  • Dashboards & Charts
  • LookML Models

In terms of permissions, we need a user with access to the Dashboards and LookML Explores that we want to ingest. You can create your API credentials following these docs.

However, LookML Views are not present in the Looker SDK. Instead, we need to extract that information directly from the GitHub repository holding the source .lkml files. In order to get this metadata, we will require a GitHub token with read only access to the repository. You can follow these steps from the GitHub documentation.

{% note %}

The GitHub credentials are completely optional. Just note that without them, we won't be able to ingest metadata out of LookML Views, including their lineage to the source databases.

{% /note %}

Python Requirements

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

pip3 install "openmetadata-ingestion[looker]"

Metadata Ingestion

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

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

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

clientId: Specify the Client ID to connect to Looker. It should have enough privileges to read all the metadata.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

clientSecret: Client Secret to connect to Looker.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

hostPort: URL to the Looker instance.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

githubCredentials (Optional): GitHub API credentials to extract LookML Views' information by parsing the source .lkml files. There are three properties we need to add in this case:

Follow these steps in order to create a fine-grained personal access token.

When configuring, give repository access to Only select repositories and choose the one containing your LookML files. Then, we only need Repository Permissions as Read-only for Contents.

{% /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: looker
  serviceName: local_looker
  serviceConnection:
    config:
      type: Looker

      clientId: Client ID

      clientSecret: Client Secret

      hostPort: http://hostPort

      githubCredentials:
        repositoryOwner: open-metadata
        repositoryName: OpenMetadata
        token: XYZ

  sourceConfig:
    config:
      type: DashboardMetadata
      overrideOwner: True
      # 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.