Skip to content

Connect an External Catalog

Audience: Application Admins

Content Summary: This page outlines how to connect an external catalog from the App Settings page.

If you want to pull tags, column details, and data source details for your data sources, use the dbt Cloud integration.

Introduction

Immuta allows you to integrate external catalogs from different tools, including Alation, Alteryx, Apache Atlas, BigID, Collibra, Google Data Catalog, and Waterline Data, each of which can be configured in the External Catalogs section of the App Settings page.

The primary purpose of connecting external catalogs and completing catalog integrations is to pull tags from the external table schemas. Immuta can ingest a data dictionary that you are already utilizing in an external catalog to help drive data policies.

Note that you will only be able to pull tags for queryable data sources.

Best Practice: External Catalog

Use a single catalog; having more than one can lead to multiple truths and data leakage.

Most External Catalogs use this tutorial to connect to Immuta. If you want to link Alation, Collibra, Waterline, Google Data, or a REST catalog, navigate to the corresponding tab below.

To link Immuta to your organization's enterprise data catalog system,

  1. Navigate to the App Settings page.
  2. Scroll to 2 External Catalogs.
  3. Click Add Catalog.
  4. Enter the Display Name and select the Catalog Type from the dropdown menu.
  5. Enter the HTTP endpoint of the catalog in the URL field.
  6. Complete the Username and Password fields. Note: This is the username and the password that Immuta can use to connect to the external catalog.
  7. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt for strict SSL by selecting the checkbox.
  8. Click the Test Connection button.

To link Immuta to an Alation data catalog,

  1. Click Add Catalog.
  2. Enter the Display Name and select Alatian from the dropdown menu.
  3. Complete the URL and API fields.
  4. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt for strict SSL by selecting the checkbox.
  5. Click the Test Connection button.

To link Immuta to a Collibra data catalog,

  1. Click Add Catalog.
  2. Enter the Display Name and select Collibra from the dropdown menu.
  3. Enter the HTTP endpoint of the catalog in the URL field.
  4. Complete the Username and Password fields. Note: This is the username and the password that Immuta can use to connect to the external catalog.
  5. Opt to Require the data source name in Collibra to contain both the schema and table name by selecting the checkbox.
  6. Complete the Asset Mappings modal to set which asset types in collibra should align to Immut's data sources and columns.
  7. Complete the Attributes as Tags modal to specify which Collibra attributes you would like to pull in as tags in Immuta.
  8. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt for strict SSL by selecting the checkbox.
  9. Click the Test Connection button.

Prerequisite: Create a service account by following Google Cloud Platform's instructions and download the JSON file containing your Google Service Account key.

  1. Click Add Catalog.
  2. Enter the Display Name and select Google Data Catalog from the dropdown menu.
  3. Upload your Google Service Account key.

    Google Data Catalog

  4. Opt to select any of the following checkboxes:

    • Keep true and false values as leaf tags
      • Don't import tags that have numeric values
      • Don't import tags that have datetime values
  5. Click Test Connection and Save the updated configuration.

Now, when a data source is created from a table in BigQuery , Immuta will import any tags that have been applied to the table in Google Data Catalog.

To link Immuta to a Waterline data catalog,

  1. Click Add Catalog.
  2. Enter the Display Name and select Waterline from the dropdown menu.
  3. Enter the HTTP endpoint of the catalog in the URL field.
  4. Complete the Username and Password fields. Note: This is the username and the password that Immuta can use to connect to the external catalog.
  5. Complete the Domain Mapping modal to map the Waterline Domains to a root tag in Immuta.
  6. Complete the Categories modal to add Waterline Categories that Immuta should search when linking data sources in Waterline.
  7. Use the dropdown menu to select between ACCEPTED or SUGGESTED the tag states Immuta will use.
  8. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt for strict SSL by selecting the checkbox.
  9. Click the Test Connection button.

To link Immuta to a REST data catalog,

  1. Click Add Catalog.
  2. Enter the Display Name and select Rest from the dropdown menu.
  3. Select the Internal Plugin checkbox if the catalog has been uploaded to Immuta as a custom server plugin.
  4. Complete the following fields:
    1. Enter the HTTP endpoint of the catalog in the URL field.
    2. Complete the Username and Password fields.
    3. Enter the path of the Tags Endpoint.
    4. Enter the path of the Data Source Endpoint.
    5. Enter the path to the information page for a data source in the Data Source Link Template field.
  5. Opt to enter the path to the information page for a column in the Column Link Template field.
  6. Opt to upload a Catalog Image.
  7. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt for strict SSL by selecting the checkbox.
  8. Click the Test Connection button.
  9. Click the Test Data Source Link.

Work with Tags from Multiple Google Cloud Platform Projects

By default, service accounts only have access to resources (such as tags) in the project where they are created. However, tags from different projects can be applied to a single table by using a tag template in Google Data Catalog.

To allow Immuta to import tags from other projects,

  1. In Google Data Catalog, navigate to an additional project with tags that have been applied to a table.
  2. Select the IAM & Admin tab from the navigation menu.
  3. Click the Add User button in the top left of the screen.
  4. Enter the email associated with the created service account. This address can be found in the downloaded JSON key file or in the IAM section of the original project.
  5. Select the TagTemplateUser role from the dropdown menu to allow access to tags.

Immuta will now import tags from this project. Further details and instructions about the TagTemplateUser role and tag templates can be found in Google Cloud Platform documentation.

What's Next

Now that you have configured the settings and connected your IAM, continue to the next page or to this index for installing a native access pattern: Native Access Patterns.