Starburst Access Control configuration#

To use Starburst access control, you enable it in the Control Plane and load it on each Starburst Enterprise platform (SEP) cluster that connects to the Control Plane. This page assumes that the Control Plane is already installed. For more information, see Control Plane installation.

Enable Starburst access control#

  1. In the Control Plane config.properties file, add the following properties:

    control-plane.enabled=true
    gateway.clusters.authentication.enabled=true
    

    control-plane.enabled enables Starburst access control and catalog management. It requires gateway.enabled=true and cluster authentication. Cluster authentication also requires a token issuer and a signing key, which you set with the gateway.clusters.authentication.issuer property and either the .secret or .private-key-file property.

  2. Run each SEP cluster in managed mode. You set managed mode with the deployment.mode=MANAGED and deployment.manager.uri properties. Managed mode loads Starburst access control on all nodes of the cluster, so you don’t need an access control file for it.

  3. In the Control Plane config.properties file, set at least one user or group with the starburst.access-control.authorized-users or starburst.access-control.authorized-groups property. These users and groups hold the accountadmin role. If you don’t set either property, no user holds the accountadmin role when the Control Plane starts. For more information about these properties, see Control Plane security.

  4. Sign in to the Control Plane UI as a user with a role that has the Manage security privilege.

To create your first role and grant privileges, see Get started.

Use built-in access control for delegated catalogs#

Starburst access control controls only governed catalogs. Delegated catalogs use the access control that the cluster loads alongside Starburst access control. New catalogs are governed by default. To move catalogs from built-in access control to Starburst access control, see Migrate to Starburst access control.

Warning

If a cluster loads only Starburst access control, nothing checks access to data in delegated catalogs, and all users can query them. To prevent this, enable built-in access control or another access control system alongside Starburst access control.

To keep using built-in access control for delegated catalogs, enable it in the config.properties file of each coordinator:

starburst.access-control.enabled=true

The cluster then loads both systems. You don’t need an access control file for either one.

For more information about how the two systems work together, see Compare with built-in access control.