Skip to content

Commit

Permalink
add more detailed steps and warnings to Databricks PL doc (#5287)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Adding additional detail to the Databricks PrivateLink doc around setup
on the Databricks side. A customer had a bad time setting this up
because of some unknown limitations on how to configure PL within
Databricks. We're trying to do a better job of illuminating those here
to avoid future customers running into the same limitations.

The bullets and warning message are what's new. I used an
`:::information` instead of a `:::caution` because the quoted text shows
up white and wasn't readable against the light yellow caution box
![Screenshot 2024-04-19 at 9 00
01 AM](https://github.com/dbt-labs/docs.getdbt.com/assets/476206/d5027636-69d3-4d15-88e9-b4bddce96b5a)
  • Loading branch information
matthewshaver authored Apr 19, 2024
2 parents c85f166 + 88810fd commit 6da2bab
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion website/docs/docs/cloud/secure/databricks-privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,17 @@ import PrivateLinkSLA from '/snippets/_PrivateLink-SLA.md';

<PrivateLinkSLA />

3. Once dbt Cloud support has notified you that setup is complete, [register the VPC endpoint in Databricks](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-3-register-privatelink-objects-and-attach-them-to-a-workspace) and attach it to the workspace
3. Once dbt Cloud support has notified you that setup is complete, [register the VPC endpoint in Databricks](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-3-register-privatelink-objects-and-attach-them-to-a-workspace) and attach it to the workspace:
- [Register your VPC endpoint](https://docs.databricks.com/en/security/network/classic/vpc-endpoints.html) &mdash; Register the VPC endpoint using the VPC endpoint ID provided by dbt Support.
- [Create a Private Access Settings object](https://docs.databricks.com/en/security/network/classic/private-access-settings.html) &mdash; 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](https://docs.databricks.com/en/security/network/classic/privatelink.html#step-3d-create-or-update-the-workspace-front-end-back-end-or-both) &mdash; 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.

:::note Warning
If using an existing Databricks workspace, all workloads running in the workspace will need to be stopped to enable Private Link! Workloads also cannot be started for another 20 minutes after making changes. From the [Databricks documentation](https://docs.databricks.com/en/security/network/classic/privatelink.html#step-3d-create-or-update-the-workspace-front-end-back-end-or-both):

>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.
:::

## Create Connection in dbt Cloud

Expand Down

0 comments on commit 6da2bab

Please sign in to comment.