Skip to content

Commit 86e2535

Browse files
committed
Updates
1 parent 1aab721 commit 86e2535

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

src/connections/storage/databricks-delta-lake/databricks-delta-lake-aws.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ This page will help you connect the Databricks Destination with AWS (S3).
1515
Please note the following prerequisites for setup.
1616

1717
1. The target Databricks workspace must be Unity Catalog enabled. Segment doesn't support the Hive metastore. Visit the Databricks guide [enabling the Unity Catalog](https://docs.databricks.com/en/data-governance/unity-catalog/enable-workspaces.html){:target="_blank"} for more information.
18-
2. The user completing the setup needs the following permissions:
19-
- AWS: The ability to create an S3 bucket and IAM role.
20-
- Databricks: Admin access at the account and workspace level.
18+
2. You'll need the following permissions for setup:
19+
- **AWS**: The ability to create an S3 bucket and IAM role.
20+
- **Databricks**: Admin access at the account and workspace level.
2121

2222
## Authentication
2323

@@ -26,11 +26,11 @@ Segment supports both OAuth and personal access token (PAT) for authentication.
2626
## Key terms
2727

2828
As you set up Databricks, keep the following key terms in mind.
29-
1. **Databricks Workspace URL**: The base URL for your Databricks workspace.
30-
2. **Service principal Application ID**: The ID tied to the service principal you'll create for Segment.
31-
3. **Service Principal Secret/Token**: The client secret or PAT you'll create for the service principal.
32-
4. **Target Unity Catalog**: The catalog where Segment lands your data.
33-
5. **Workspace Admin Token** (*PAT only*): The access token you'll generate for your Databricks workspace admin.
29+
- **Databricks Workspace URL**: The base URL for your Databricks workspace.
30+
- **Service principal Application ID**: The ID tied to the service principal you'll create for Segment.
31+
- **Service Principal Secret/Token**: The client secret or PAT you'll create for the service principal.
32+
- **Target Unity Catalog**: The catalog where Segment lands your data.
33+
- **Workspace Admin Token** (*PAT only*): The access token you'll generate for your Databricks workspace admin.
3434

3535
## Setup
3636

@@ -45,7 +45,7 @@ The workspace URL is used by you and Segment to access your workspace API.
4545

4646
The service principal is used by Segment to access your Databricks workspace and associated APIs.
4747
1. Follow the Databricks [guide](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-service-principals-in-your-account){:target="_blank"} for adding a service principal to your account and assigning to the workspace. This name can be anything, but Segment recommends something that identifies the purpose (for example, `Segment Storage Destinations`). Note the Application ID that Databricks generates for later use. Segment doesn't require Account admin or Marketplace admin roles.
48-
2. (*OAuth only*) Follow the Databricks instructions to [generate an OAuth secret](https://docs.databricks.com/en/dev-tools/authentication-oauth.html#step-2-create-an-oauth-secret-for-a-service-principal){:target="_blank"}. Note the secret generated by Databricks for later use. Once you navigate away from this page the Secret is no longer visible. If you lose or forget the secret, you can delete the existing secret and create a new one.
48+
2. (*OAuth only*) Follow the Databricks instructions to [generate an OAuth secret](https://docs.databricks.com/en/dev-tools/authentication-oauth.html#step-2-create-an-oauth-secret-for-a-service-principal){:target="_blank"}. Note the secret generated by Databricks for later use. Once you navigate away from this page the secret is no longer visible. If you lose or forget the secret, you can delete the existing secret and create a new one.
4949

5050
### Step 3: Enable entitlements for the service principal on the workspace
5151

@@ -54,7 +54,7 @@ This step allows the Segment service principal to create and use a small SQL war
5454

5555
### Step 4: Create an external location and storage credentials
5656

57-
This step creates the storage location where Segment lands your Delta lake and the associated credentials Segment uses to access the storage.
57+
This step creates the storage location where Segment lands your delta lake and the associated credentials Segment uses to access the storage.
5858
1. Follow the Databricks guide for [managing external locations and storage credentials](https://docs.databricks.com/en/data-governance/unity-catalog/manage-external-locations-and-credentials.html){:target="_blank"}. This guide assumes the target S3 bucket already exists. If not, follow the [AWS guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html){:target="_blank"} for creating a bucket.
5959
2. Once the external location and storage credentials are created in your Databricks workspace, update the permissions to allow access to the Segment service principal.
6060
1. In your workspace, navigate to **Data > External Data > Storage Credentials**.
@@ -104,7 +104,7 @@ The Trust policy should look like:
104104

105105
### Step 5: Create a workspace admin access token (PAT only)
106106

107-
The workspace admin access token is used by your Databricks workspace admin to generate a personal access token for the service principal.
107+
Your Databricks workspace admin uses the workspace admin access token to generate a personal access token for the service principal.
108108
1. Follow the Databricks guide for [generating personal access tokens](https://docs.databricks.com/en/dev-tools/auth.html#databricks-personal-access-tokens-for-workspace-users){:target="_blank"} for workspace users. Note the generated token for later use.
109109

110110
### Step 6: Enable personal access tokens for the workspace (PAT only)
@@ -115,7 +115,7 @@ This step allows the creation and use of personal access tokens for the workspac
115115

116116
### Step 7: Generate a personal access token for the service principal (PAT only)
117117

118-
The personal access token is the token used by Segment to access the Databricks workspace API. The Databricks UI doesn't allow for the creation of service principal tokens. Tokens must be generated using either the Databricks workspace API (*recommended*) or the Databricks CLI.
118+
Segment uses the personal access token to access the Databricks workspace API. The Databricks UI doesn't allow for the creation of service principal tokens. Tokens must be generated using either the Databricks workspace API (*recommended*) or the Databricks CLI.
119119
1. Generating a token requires the following values:
120120
- **Databricks Workspace URL**: The base URL to your Databricks workspace.
121121
- **Workspace Admin Token**: The token generated for your Databricks admin user.
@@ -140,7 +140,7 @@ databricks token-management create-obo-token
140140

141141
This catalog is the target catalog where Segment lands your schemas/tables.
142142
1. Follow the Databricks guide for [creating a catalog](https://docs.databricks.com/en/data-governance/unity-catalog/create-catalogs.html#create-a-catalog){:target="_blank"}.
143-
- Be sure to select the storage location created earlier. You can use any valid catalog name (for example, "Segment"). Note the catalog name for later use.
143+
- Be sure to select the storage location created earlier. You can use any valid catalog name (for example, "Segment"). Note this name for later use.
144144
2. Select the catalog you've just created.
145145
1. Select the Permissions tab, then click **Grant**
146146
2. Select the Segment service principal from the dropdown, and check `ALL PRIVILEGES`.

src/connections/storage/databricks-delta-lake/databricks-delta-lake-azure.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ This page will help you connect the Databricks Destination with Azure.
1414

1515
Please note the following pre-requisites for setup.
1616

17-
1. The target Databricks workspace must be Unity Catalog enabled. Segment doesn't support the Hive megastore. Visit the Databricks guide for [enabling Unity Catalog](https://learn.microsoft.com/en-us/azure/databricks/data-governance/unity-catalog/enable-workspaces){:target="_blank"} for more info.
18-
2. The user completing setup needs the following permissions:
17+
1. Your Databricks workspace must be Unity Catalog enabled. Segment doesn't support the Hive metastore. Visit the Databricks guide for [enabling Unity Catalog](https://learn.microsoft.com/en-us/azure/databricks/data-governance/unity-catalog/enable-workspaces){:target="_blank"} for more info.
18+
2. You'll need the following permissions for setup:
1919
- **Azure**: Ability to create service principals, as well as create and manage the destination storage container and its associated role assignments.
2020
- **Databricks**: Admin access to the account and workspace level.
2121

2222
## Key terms
2323

2424
As you set up Databricks, keep the following key terms in mind.
2525

26-
1. **Databricks Workspace URL**: The base URL for your Databricks workspace.
27-
2. **Target Unity Catalog**: The catalog where Segment lands your data.
26+
- **Databricks Workspace URL**: The base URL for your Databricks workspace.
27+
- **Target Unity Catalog**: The catalog where Segment lands your data.
2828

2929
## Set up Databricks with Azure
3030

@@ -38,7 +38,7 @@ Check your browser's address bar when in your workspace. The workspace URL will
3838

3939
### Step 2: Add the Segment Storage Destinations service principal to your Entra ID (Active Directory)
4040

41-
The service principal is used by Segment to access your Databricks workspace APIs as well as your ADLS Gen2 storage container. You can use either Azure PowerShell or the Azure CLI.
41+
Segment uses the service principal to access your Databricks workspace APIs as well as your ADLS Gen2 storage container. You can use either Azure PowerShell or the Azure CLI.
4242

4343
1. **Recommended**: Azure PowerShell
4444
1. Log in to the Azure console with a user allowed to add new service principals.
@@ -84,15 +84,15 @@ This step allows Segment to access your workspace.
8484

8585
### Step 5: Enable entitlements for the service principal on the workspace
8686

87-
This step allows the Segment service principal to create and use a small SQL warehouse to create and update table schemas in the Unity Catalog.
87+
This step allows the Segment service principal to create a small SQL warehouse for creating and updating table schemas in the Unity Catalog.
8888

8989
1. Follow the [managing workspace entitlements](https://learn.microsoft.com/en-us/azure/databricks/administration-guide/users-groups/service-principals#--manage-workspace-entitlements-for-a-service-principal){:target="_blank"} instructions for a service principal. Segment requires `Allow cluster creation` and `Databricks SQL access` entitlements.
9090

9191
### Step 6: Create an external location and storage credentials
9292

93-
This step creates the storage location where Segment lands your Delta lake and the associated credentials Segment uses to access the storage.
93+
This step creates the storage location where Segment lands your delta lake and the associated credentials Segment uses to access the storage.
9494
1. Follow the Databricks guide for [managing external locations and storage credentials](https://learn.microsoft.com/en-us/azure/databricks/data-governance/unity-catalog/manage-external-locations-and-credentials){:target="_blank"}.
95-
- Use the storage container that you updated in step 3.
95+
- Use the storage container you updated in step 3.
9696
- For storage credentials, you can use a service principal or managed identity.
9797
2. Once you create the external location and storage credentials in your Databricks workspace, update the permissions to allow access to the Segment service principal.
9898
- In your workspace, navigate to **Data > External Data > Storage Credientials**. Click the name of the credentials created above and go to the Permissions tab. Click **Grant**, then select the Segment service principal from the drop down. Select the following checkboxes:

0 commit comments

Comments
 (0)