Skip to content

You are viewing documentation for Immuta version 2021.5.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

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.

Supported External Catalogs

The only external catalogs that Immuta supports are

Introduction

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 using in an external catalog to 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 leaks.

  1. Navigate to the App Settings page.

  2. Scroll to 2 External Catalogs, and click Add Catalog.

    Add Catalog

  3. Enter a Display Name and select Alation from the dropdown menu.

  4. Complete the URL and API fields.

    Alation

  5. Opt to select Upload Certificates.

    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt to enable Strict SSL by selecting the checkbox.

  6. Click the Test Connection button.

    Test Connection

  7. Once the connection is successful, click Save.

  1. Navigate to the App Settings page.

  2. Scroll to 2 External Catalogs, and click Add Catalog.

    Add Catalog

  3. Enter the Display Name and select Collibra from the dropdown menu.

  4. Enter the HTTP endpoint of the catalog in the URL field.

  5. Complete the Username and Password fields. Note: This is the username and the password that Immuta can use to connect to the external catalog.

    Collibra

  6. Opt to Require the data source name in Collibra to contain both the schema and table name by selecting the checkbox.

  7. Complete the Asset Mappings modal to set which asset types in Collibra should align to Immuta's data sources and columns.
  8. Complete the Attributes as Tags modal to specify which Collibra attributes you would like to pull in as tags in Immuta.
  9. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt to enable Strict SSL by selecting the checkbox.

  10. Click the Test Connection button.

    Test Connection

  11. Once the connection is successful, click Save.

Integrating a Custom REST Catalog service with Immuta requires implementing a REST interface. For details about the necessary endpoints that must be serviced, see the Custom REST Catalog Interface Endpoints page.

  1. Navigate to the App Settings page.

  2. Scroll to 2 External Catalogs, and click Add Catalog.

    Add Catalog

  3. Enter the Display Name and select Rest from the dropdown menu.

  4. Select the Internal Plugin checkbox if the catalog has been uploaded to Immuta as a custom server plugin.

    Rest Catalog

  5. 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.
  6. Opt to enter the path to the information page for a column in the Column Link Template field.
  7. Opt to upload a Catalog Image.
  8. Opt to select Upload Certificates.
    1. Upload the Certificate Authority, Certificate File, and Key File.
    2. Opt to enable Strict SSL by selecting the checkbox.

  9. Click the Test Connection button.

    Test Connection

  10. Click the Test Data Source Link.

  11. Once both tests are successful, click Save.

Enable Snowflake catalog with Snowflake integration

The Snowflake catalog can be enabled when configuring a native Snowflake integration from the App Settings page. This tutorial is intended for users who want Snowflake tags to be ingested into Immuta but do not want users to query data sources natively in Snowflake.

  1. Navigate to the App Settings page.

  2. Scroll to 2 External Catalogs, and click Add Catalog.

    Add Catalog

  3. Enter a Display Name and select Snowflake from the dropdown menu.

  4. Enter the Account.

    Snowflake

  5. Enter the Authentication information: Username, Password, Port, Default Warehouse, and Role.

    Snowflake User Authentication

    In order to configure the Snowflake external catalog integration, which syncs Snowflake tags into Immuta, you must provide a Snowflake user who has, at minimum, the ability to set the following privileges:

    • GRANT IMPORTED PRIVILEGES ON DATABASE snowflake
    • GRANT APPLY TAG ON ACCOUNT

  6. Opt to enter the Proxy Host, Proxy Port, and Encrypted Key File Passphrase.

  7. Opt to Upload Certificates.

  8. Click the Test Connection button.

    Test Connection

  9. Click the Test Data Source Link.

  10. Once both tests are successful, click Save.

For pre-existing data sources in Immuta, you can manually link them to external catalogs from the Data Source Overview tab.

  1. Navigate to your data source and click Link in the Data Catalog section on the right side of the page.

  2. Select your external catalog from the dropdown menu.

    Link Catalog

  3. Click Link to confirm.

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.