External Catalogs

Audience: Application Admins

Content Summary: Immuta allows you to integrate external catalogs from different tools, such as Alation and Collibra, which can be configured in the External Catalogs section of the App Settings page.

However, if you have contacted the Immuta Support team and they have instructed you to add advanced configuration options, these options can be managed in the Advanced Configuration section of the Application Settings page. This page outlines configuration and examples for the Collibra integration and a Custom REST Catalog.

For information about governing data from external catalogs, navigate to the Tags Guide.

Immuta can integrate a variety of data sources for external catalogs. For additional information contact an Immuta Support Professional.

Configuring Collibra Integration

In your config.yml file, include the following under plugins. If you have preexisting plugins in your configuration, simply append collibra to the plugins set.

Parameters:

• requestOptions:
  • uri: Collibra's integration endpoint.
• authentication:
  • username: username for the integration.
  • password: password for the integration.
• assetMapping: an array of data source nodes.
  • dataSource: table name to import.
  • columns: columns to import.
  • columnsAreSource: when true, indicates that the specified columns are the source asset, and the data source is the target. Set to false to invert this relationship.

Example:

# config.yml
# ...
  plugins:
    collibra:
      requestOptions:
        uri: 'https://techintegrations.collibra.com'
      authentication:
        username: '<USERNAME>'
        password: '<PASSWORD>'
      assetMapping:
      - dataSource: '<TABLE_1>'
        columns: '<COLUMN> '
        columnsAreSource: true
      - dataSource: '<TABLE_2>'
        columns: '<COLUMN>'
        columnsAreSource: true
# ...

Configuring a REST Catalog Integration

Once you have a REST Catalog running, you can configure Immuta to connect to it.

You must have the APPLICATION_ADMIN permission in order to configure catalogs in Immuta.

1. On the Immuta navigation bar, click App Settings.
2. Select External Catalogs from the Configuration menu.
3. Click Add Catalog.
4. Select Rest from the dropdown.
5. Fill in the following fields:
   • URL is the HTTP endpoint of your catalog (e.g., http://my.rest.catalog)
   • Username and Password are the HTTP Basic Auth credentials
   • Tag Endpoint is the path of the tags endpoint (e.g., /tags)
   • Data Source Endpoint is the path of the data source endpoint (e.g., /dataSource)
   • Data Source Link Template is the path to the human-readable information page for a data source. The value is a template that contains the token {id}, which Immuta will replace with the data source ID when the link is rendered.
   • Column Link Template is the path to the human-readable information page for a column. The value is a template that contains the token {id}, which Immuta will replace with the column ID when the link is rendered.
6. Upload an icon for the catalog by clicking on the Catalog Image field.
7. Test the connection and the data source link with the Test buttons.
8. Finally, click Add Catalog.