Crawl Looker
Once you have configured the Looker user permissions, you can establish a connection between Atlan and Looker.
To crawl metadata from Looker, review the order of operations and then complete the following steps.
Select source
To select Looker as your source:
- In the top right of any screen, navigate to New and then click New Workflow.
- From the list of packages, select Looker Assets and click on Setup Workflow.
Configure extraction
Select your extraction method and provide the connection details.
- Direct
- Offline
- Agent
In Direct extraction, Atlan connects to Looker and crawls metadata directly.
- For Host Name, enter the full URL for your Looker API host, including the
https://. - For Port, keep 443 for Looker instances created after July 7, 2020, or switch to 19999 for older instances.
- For Client ID, enter the client ID you generated when setting up user permissions.
- For Client Secret, enter the client secret you generated when setting up user permissions.
- Click Test Authentication to confirm connectivity to Looker using these details.
Field level lineage
To enable field-level lineage, select a clone method for your Looker project Git repositories:
- SSH
- HTTPS
- For Private SSH Key, paste the private SSH key for the key you configured in GitHub.
- For Passphrase for the private key, enter the passphrase that protects the key, if any. (If the key isn't protected by a passphrase, leave this blank.)
- For SSH Known Hosts, add any value that needs to be hardcoded in the
~/.ssh/known-hostsfile before cloning your project Git repositories using SSH. (If not required, leave this blank.)
- For Git Username, enter the username associated with your access token. If your Git provider doesn't require a specific username, enter
oauth2. - For Git Token, enter a valid access token for your Git provider account. For more details, see HTTPS token for lineage.
In Offline extraction, you use Atlan’s looker-extractor tool to extract metadata from Looker and store it in S3. You need to first extract the metadata yourself and then make it available in S3.
- For Bucket name, enter the name of your S3 bucket or Atlan’s bucket.
- For Bucket prefix, enter the S3 prefix under which all the metadata files exist. These include
projects.json,dashboards.json,connections.json, androles.json. - For Bucket region, enter the name of the S3 region.
- Click Next at the bottom of the screen.
In Agent extraction, the Secure Agent executes metadata extraction within your organization’s environment.
- Select the Agent tab.
- Store sensitive information in the secret store configured with the Secure Agent and reference the secrets in the corresponding fields. For details on individual fields, including field-level lineage configuration, refer to the Direct extraction tab.
- Complete the Secure Agent configuration by following the instructions in the How to configure Secure Agent for workflow execution guide.
- Click Next after completing the configuration.
Configure connection
To complete the Looker connection configuration:
-
Provide a Connection Name that represents your source environment. For example, you might want to use values like
production,development,gold, oranalytics. -
(Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.
warningIf you don't specify any user or group, nobody can manage the connection - not even admins.
-
At the bottom of the screen, click the Next button to proceed.
Configure crawler
Before running the Looker crawler, you can further configure it. (These options are only available when using the direct extraction method.)
Configure metadata
You can override the defaults for any of these options:
- Looker folders contain saved content, such as dashboards, looks, and tiles:
- To select the Looker folders you want to include in crawling, click Include Folders. (Defaults to all folders, if none are specified.)
- To select the Looker folders you want to exclude from crawling, click Exclude Folders. (Defaults to no folders, if none are specified.)
- Looker projects contain LookML files, such as models, views, and explores:
- To select the Looker projects you want to include in crawling, click Include Projects. (Defaults to all projects, if none are specified.)
- To select the Looker projects you want to exclude from crawling, click Exclude Projects. (Defaults to no projects, if none are specified.)
If a folder or project appears in both the include and exclude filters, the exclude filter takes precedence.
Configure advanced settings
- For Use Field Level Lineage, click True to enable crawling field-level lineage for Looker or click False to disable it.
Run crawler
To run the Looker crawler, after completing the previous steps:
- To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
- You can either:
- To run the crawler once immediately, at the bottom of the screen, click the Run button.
- To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.
Once the crawler has completed running, the assets appear in Atlan's asset page! 🎉