Configure and remove a service connection¶

The Polaris Catalog™ administrator configures a new service connection by using Polaris Catalog. After you configure a service connection, you can then register it, which connects the query engine that uses the connection to a catalog in Polaris Catalog. You can use the same service connection for one or multiple query engines. For more information about service connections, see Service connection.

When you configure a new service connection, you specify:

A principal role to grant the service principal for the connection with this principal role. You can use a principal role to logically group Polaris Catalog service principals together. For more information, including examples of principal roles, see Principal role.
The query engine that users will use with the connection, such as Apache Spark.

When you configure a service connection, the service credentials for its service principal are created. You specify these service credentials when you register the service connection.

Configure a service connection¶

To configure a new service connection, do the following:

Sign in to Polaris Catalog.
From the menu on the left, select Connections.
Select + Connection.
From the Configure Service Connection dialog, complete the fields:
1. In the Query Engine field, select the query engine for the service connection.
2. In the Name field, Enter a service principal name. You can enter a user-friendly name, so the connection is easier to identify and use in tools. For more information, including examples, see Service principal.
3. To grant the service principal with a principal role, do one of the following:
  - To grant the service principal with an existing principal role, in the Principal Role field, select a principal role. You can select an existing principal role to grant the same privileges to multiple service principals, such as a principal role named DATA_ENGINEERS.
  - To grant the service principal with a new principal role, move the Create new principal role toggle to On and then in the Principal Role field, enter a name for the new principal role.
Select Create. The Client ID and Client Secret service credentials for the service principal are created.
From the Configure Service Connection dialog, save the service credentials:
1. To copy the Client ID, select the Copy client id icon inside the Client ID field and paste it to a file.
2. To copy the Client Secret, select the Copy secret icon inside the Client Secret field and paste it to a file.
3. To copy both the Client ID and Client Secret and in the format that they need to be specified when you register the service connection, select the Copy icon inside the As : field.
  
  Important
  
  You must save the service credentials before you close the Configure Service Connection window, because you can’t retrieve them later.
Select Close.

Remove a service connection¶

If you no longer need to use a service connection, remove it.

To remove a service connection, do the following:

Sign in to Polaris Catalog.
From the menu on the left, select Connections.
From the list of connections, locate the service connection you want to remove.
Under the MORE column, select … for the connection you want to remove.
Select Delete.