Databricks: Managing Access to Groups

In this tutorial, you'll learn how to configure Grant Kits to automate access requests to a Databricks Group by attaching Group Members. This use case models Role-Based Access Control (RBAC) for Databricks.

We will be using the Databricks Starter Kit as a base and replace configuration stubs for our use case.

Before you start

1. Make sure you have:

   • An Abbey account

   • An Abbey API Token

   • A Databricks account

2. Make sure you setup:

   1. A Databricks Starter Kit by following Get a Starter Kit

   2. A Connection to a repo by following Connect a Repo

Step 1: Configure Your Grant Kit

Configure Output

Grant Kits rely on your GitHub account and repository name to output access changes, which we'll set through Terraform local variables. Update the locals block in main.tf with your account_name and repo_name

main.tf

 locals {
  account_name = "" #CHANGEME
  repo_name = "" #CHANGEME
  ...
}

Configure Reviewers

Workflow defines who should approve an access request.

Let's update the reviewers block by adding yourself as the reviewer by switching [e-mail] with the email address you use to sign into Abbey.

main.tf

 resource "abbey_grant_kit" "..." {
   ...
   workflow = {
     steps = [
       {
         reviewers = {
-          one_of = ["[e-mail]"] # CHANGEME
+          one_of = ["[e-mail]"]

Step 3: Link Databricks with Abbey

Now you'll need to link Databricks with Abbey.

curl -X POST \
  -H "Authorization: Bearer $ABBEY_API_TOKEN" \
  -H 'Content-Type: application/json' \
  https://api.abbey.io/v1/users/<user_id>/apps \
  -d '{"type": "databricks", "data": {"user_name": "<your Databricks user name", "tf_resource_id": "<the id of the Terraform resource for your user>"}}'

Step 3: Replace Databricks-Related Stubs

You'll need to log into your Databricks account to get your database, role, user(s), table schema, and table name.

main.tf

...

resource "databricks_group" "pii_group" {
  display_name               = "PII Group"
  allow_cluster_create       = true
  allow_instance_pool_create = true
}

- resource "databricks_user" "replace_me_user" {
+ resource "databricks_user" "alice_user" {
-  user_name    = "[e-mail]"
+  user_name    = "[e-mail]"
}

...

Step 4: Deploy Your Starter Kit

First, add your Databricks-related secrets to your repo:

• DATABRICKS_HOST

• DATABRICKS_TOKEN

You can find this information in your Databricks account.

What should it look like?

To deploy your Starter Kit, follow instructions from Deploy Your Grant Kit.

Step 5: Automate Access Management

🎉 Congratulations! Abbey is now managing permissions to your Databricks Group for you. 🎉

You can now start requesting and approving access by following the Request Access and Approve or Deny Access Requests guides.

Abbey strives to help you automate and secure access management without being intrusive.

To that end, this Pull Request contains native Terraform HCL code using normal open source Terraform Provider libraries. It represents the permissions change. In this case, it's just a simple creation of a new Terraform Resource.

Next Steps

To learn more about what Resources you can configure, try one of our Tutorials.

For more information on how Abbey works, visit the Key Concepts or Grant Kits page.