Configure Starburst Integration

This page details how to install the Starburst integration.

Requirement

1 - Enable the Integration

Click the App Settings icon in the left sidebar.
Click the Integrations tab.
Click Add Native Integration and select Trino from the Native Integration Type dropdown menu.
Click Save.

OAuth Authentication

If you are using OAuth or asynchronous authentication to create Starburst data sources, work with your Immuta representative to configure the globalAdminUsername property.

2 - Configure the Immuta System Access Control Plugin in Starburst

Default Configuration Property Values

If you use the default property values in the configuration file described in this section,

you will give users read and write access to tables that are not registered in Immuta and
results for SHOW queries will not be filtered on table metadata.

These default settings help ensure that a new Starburst integration installation is minimally disruptive for existing Starburst deployments, allowing you to then add Immuta data sources and update configuration to enforce more controls as you see fit.

However, the access-control.config-files property can be configured to allow Immuta to work with existing Starburst installations that have already configured an access control provider. For example, if the Starburst integration is configured to allow users write access to tables that are not protected by Immuta, you can still lock down write access for specific non-Immuta tables using an additional access control provider.

Create the Immuta access control configuration file in the Starburst configuration directory (/etc/starburst/immuta-access-control.properties for Docker installations or <starburst_install_directory>/etc/immuta-access-control.properties for standalone installations).

The table below describes the properties that can be set during configuration.

Property	Starburst version	Required or optional	Description
`access-control.name`	392 and newer	Required	This property enables the integration.
`access-control.config-files`	392 and newer	Optional	Starburst allows you to enable multiple system access control providers at the same time. To do so, add providers to this property as comma-separated values. Immuta has tested the Immuta system access control provider alongside the Starburst built-in access control system. This approach allows Immuta to work with existing Starburst installations that have already configured an access control provider. Immuta does not manage all permissions in Starburst and will default to allowing access to anything Immuta does not manage so that the Starburst integration complements existing controls. For example, if the Starburst integration is configured to allow users write access to tables that are not protected by Immuta, you can still lock down write access for specific non-Immuta tables using an additional access control provider.
`immuta.allowed.immuta.datasource.operations`	413 and newer	Optional	This property defines a comma-separated list of allowed operations for users on Immuta data sources they are subscribed to: `READ`,`WRITE`, and `OWN`. (See the Customize read and write access policies for Starburst guide for details about the `OWN` operation.) When set to `WRITE`, all users granted access to a data source through a subscription policy are allowed read and write operations to data source schemas and tables. By default, this property is set to `READ`, which blocks write operations on data source tables and schemas. If write policies are enabled for your Immuta tenant, this property is set to `READ,WRITE` by default, so users granted write access to a data source through a write access subscription policy are allowed read and write operations to data source schemas and tables.
`immuta.allowed.non.immuta.datasource.operations`	392 and newer	Optional	This property defines a comma-separated list of allowed operations users will have on tables not registered as Immuta data sources: `READ`, `WRITE`, `CREATE`, and `OWN`. (See the Customize read and write access policies for Starburst guide for details about `CREATE` and `OWN` operations.) When set to `READ`, users are allowed read operations on tables not registered as Immuta data sources. When set to `WRITE`, users are allowed read and write operations on tables not registered as Immuta data sources. If this property is left empty, users will not get access to any tables outside Immuta. By default, this property is set to `READ,WRITE`. If write policies are enabled for your Immuta tenant, this property is set to `READ,WRITE,OWN,CREATE` by default.
`immuta.apikey`	392 and newer	Required	This should be set to the Immuta API key displayed when enabling the integration on the app settings page.
`immuta.ca-file`	392 and newer	Optional	This property allows you to specify a path to your CA file.
`immuta.cache.views.seconds`	392 and newer	Optional	Amount of time in seconds for which a user's specific representation of an Immuta data source will be cached for. Changing this will impact how quickly policy changes are reflected for users actively querying Starburst. By default, cache expires after 30 seconds.
`immuta.cache.datasource.seconds`	392 and newer	Optional	Amount of time in seconds for which a user's available Immuta data sources will be cached for. Changing this will impact how quickly data sources will be available due to changing projects or subscriptions. By default, cache expires after 30 seconds.
`immuta.endpoint`	392 and newer	Required	The protocol and fully qualified domain name (FQDN) for the Immuta tenant used by Starburst (for example, `https://my.immuta.tenant.io`). This should be set to the endpoint displayed when enabling the integration on the app settings page.
`immuta.filter.unallowed.table.metadata`	392 and newer	Optional	When set to false, Immuta won't filter unallowed table metadata, which helps ensure Immuta remains noninvasive and performant. If this property is set to true, running `show catalogs`, for example, will reflect what that user has access to instead of returning all catalogs. By default, this property is set to false.
`immuta.group.admin`	420 and newer	Required if `immuta.user.admin` is not set	This property identifies the Starburst group that is the Immuta administrator. The users in this group will not have Immuta policies applied to them. Therefore, data sources should be created by users in this group so that they have access to everything. Note that you must escape regex special characters (for example, `john\\.doe+svcacct@immuta\\.com`).
`immuta.user.admin`	392 and newer	Required if `immuta.group.admin` is not set	This property identifies the Starburst user who is an Immuta administrator (for example, `immuta.user.admin=immuta_system_account`). This user will not have Immuta policies applied to them because this account will run the subqueries. Therefore, data sources should be created by this user so that they have access to everything. Note that you must escape regex special characters (for example, `john\\.doe+svcacct@immuta\\.com`).

Enable the Immuta access control plugin in Starburst's configuration file (/etc/starburst/config.properties for Docker installations or <starburst_install_directory>/etc/config.properties for standalone installations). For example,
```
access-control.config-files=/etc/starburst/immuta-access-control.properties
```

Example Immuta System Access Control Configuration

The example configuration snippet below uses the default configuration settings for immuta.allowed.immuta.datasource.operations and immuta.allowed.non.immuta.datasource.operations, which allow read access for data registered as Immuta data sources and read and write access on data that is not registered in Immuta. See the Granting Starburst privileges section for details about customizing and enforcing read and write access controls in Starburst.

# Enable the Immuta System Access Control (v2) implementation.
access-control.name=immuta

# The Immuta endpoint that was displayed when enabling the Starburst integration in Immuta.
immuta.endpoint=http://service.immuta.com:3000

# The Immuta API key that was displayed when enabling the Starburst integration in Immuta.
immuta.apikey=45jdljfkoe82b13eccfb9c

# The administrator user regex. Starburst usernames matching this regex will not be subject to
# Immuta policies. This regex should match the user name provided at Immuta data source
# registration.
immuta.user.admin=immuta_system_account

# Optional argument (default is shown).
# A CSV list of operations allowed on schemas/tables registered as Immuta data sources.
immuta.allowed.immuta.datasource.operations=READ

# Optional argument (default is shown).
# A CSV list of operations allowed on schemas/tables not registered as Immuta data sources.
# Set to empty to allow no operations on non-Immuta data sources.
immuta.allowed.non.immuta.datasource.operations=READ,WRITE

# Optional argument (default is shown).
# Controls table metadata filtering for inaccessible tables.
#   - When this property is enabled and non-Immuta reads are also enabled, a user performing
#     'show catalogs/schemas/tables' will not see metadata for a table that is registered as
#     an Immuta data source but the user does not have access to through Immuta.
#   - When this property is enabled and non-Immuta reads and writes are disabled, a user
#     performing 'show catalogs/schemas/tables' will only see metadata for tables that the
#     user has access to through Immuta.
#   - When this property is disabled, a user performing 'show catalogs/schemas/tables' can see
#     all metadata.
immuta.filter.unallowed.table.metadata=false

3 - Add Starburst Users to Immuta

Configure your external IAM to add users to Immuta.
Map their Starburst usernames when configuring your IAM (or map usernames manually) to Immuta.
- All Starburst users must map to Immuta users or match the immuta.user.admin regex configured on the cluster, and their Starburst username must be mapped to Immuta so they can query policy-enforced data.
- A user impersonating a different user in Starburst requires the IMPERSONATE_USER permission in Immuta. Both users must be mapped to an Immuta user, or the querying user must match the configured immuta.user.admin regex.