Skip to main content

Configuring Databricks PrivateLink

Limited to certain Enterprise tiers

The PrivateLink feature is available on the following dbt Cloud Enterprise tiers:

  • Business Critical
  • Virtual Private

To learn more about these tiers, contact us at sales@getdbt.com.

The following steps will walk you through the setup of a Databricks AWS PrivateLink or Azure Private Link endpoint in the dbt Cloud multi-tenant environment.

PrivateLink endpoints can't connect across cloud providers. For a PrivateLink connection to work, both dbt Cloud and the server (like Databricks) must be hosted on the same cloud provider. For example, dbt Cloud hosted on AWS cannot connect via PrivateLink to services hosted on Azure, and dbt Cloud hosted on Azure can’t connect via Private Link to services hosted on AWS.

  1. Locate your Databricks instance name

    • Example: cust-success.cloud.databricks.com

  2. Add the required information to the following template and submit your AWS PrivateLink request to dbt Support:

    Subject: New AWS Multi-Tenant PrivateLink Request
    - Type: Databricks
    - Databricks instance name:
    - Databricks cluster AWS Region (e.g., us-east-1, eu-west-2):
    - dbt Cloud multi-tenant environment (US, EMEA, AU):

    dbt Labs will work on your behalf to complete the PrivateLink setup. Please allow 3-5 business days for this process to complete. Support will contact you when the endpoint is available.

  3. Once dbt Cloud support has notified you that setup is complete, register the VPC endpoint in Databricks and attach it to the workspace:

    • Register your VPC endpoint — Register the VPC endpoint using the VPC endpoint ID provided by dbt Support.
    • Create a Private Access Settings object — Create a Private Access Settings (PAS) object with your desired public access settings, and setting Private Access Level to Endpoint. Choose the registered endpoint created in the previous step.
    • Create or update your workspace — Create a workspace, or update your an existing workspace. Under Advanced configurations → Private Link choose the private access settings object created in the previous step.
    warning

    If using an existing Databricks workspace, all workloads running in the workspace need to be stopped to enable Private Link. Workloads also can't be started for another 20 minutes after making changes. From the Databricks documentation:

    "After creating (or updating) a workspace, wait until it’s available for using or creating clusters. The workspace status stays at status RUNNING and the VPC change happens immediately. However, you cannot use or create clusters for another 20 minutes. If you create or use clusters before this time interval elapses, clusters do not launch successfully, fail, or could cause other unexpected behavior."

  1. Navigate to your Azure Databricks workspace. The path format is: /subscriptions/<subscription_uuid>/resourceGroups/<resource_group_name>/providers/Microsoft.Databricks/workspaces/<workspace_name>.
  2. From the workspace overview, click JSON view.
  3. Copy the value in the resource_id field.
  4. Add the required information to the following template and submit your Azure Private Link request to dbt Support: 
      Subject: New Azure Multi-Tenant Private Link Request
    - Type: Databricks
    - Databricks instance name:
    - Databricks Azure resource ID:
    - dbt Cloud multi-tenant environment: EMEA
  5. Once our Support team confirms the resources are available in the Azure portal, navigate to the Azure Databricks Workspace and browse to Networking > Private Endpoint Connections. Then, highlight the dbt named option and select Approve.

Create Connection in dbt Cloud​

Once you've completed the setup in the Databricks environment, you will be able to configure a private endpoint in dbt Cloud:

  1. Navigate to Settings → Create new project → select Databricks.
  2. You will see two radio buttons: Public and Private. Select Private.
  3. Select the private endpoint from the dropdown (this will automatically populate the hostname/account field).
  4. Configure the remaining data platform details.
  5. Test your connection and save it.
0
Edit this page