Run Looker using the metadata CLI
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:
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.
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:
Source Configuration - Service Connection
- hostPort: URL to the Looker instance.
- username: Specify the User to connect to Looker. It should have enough privileges to read all the metadata.
- password: Password to connect to Looker.
- env: Looker Environment.
Source Configuration - Source Config
sourceConfig is defined here:
dbServiceName: Database Service Name for the creation of lineage, if the source supports it.
chartFilterPattern: Note that the dashboardFilterPattern and chartFilterPattern both support regex as include or exclude. E.g.,
dashboardFilterPattern: includes: - users - type_test
To send the metadata to OpenMetadata, it needs to be specified as
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. An example of an Auth0 configuration would be the following:
workflowConfig: openMetadataServerConfig: hostPort: http://localhost:8585/api authProvider: auth0 securityConfig: clientId: <client ID> secretKey: <secret key> domain: <domain>
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.