mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-30 14:57:36 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
94 lines
4.8 KiB
Plaintext
94 lines
4.8 KiB
Plaintext
---
|
|
title: "Databricks Connection"
|
|
description: "Learn how to configure a Databricks Connection for KMS."
|
|
---
|
|
|
|
KMS supports the use of [service principals](https://docs.databricks.com/en/admin/users-groups/service-principals.html) to connect with your Databricks workspaces.
|
|
|
|
## Configure a Service Principal for KMS
|
|
|
|
<Steps>
|
|
<Step title="Databricks Workspace Settings">
|
|
Navigate to your Databricks Workspace **Settings** via the dropdown in the top right.
|
|
|
|
</Step>
|
|
<Step title="Manage Service Principals">
|
|
Under the **Identity & Access** tab, click the **Manage** button in the **Service Principals** section.
|
|
|
|
|
|
</Step>
|
|
<Step title="Service Principal Management">
|
|
Click the **Add Service Principal** button.
|
|
|
|
|
|
</Step>
|
|
<Step title="Add Service Principal">
|
|
Select the **Add New** option and create a service principal for KMS.
|
|
|
|
|
|
</Step>
|
|
<Step title="Generate Service Principal Secret">
|
|
Click on your new service principal, select the **Secrets** tab and click the **Generate Secret** button.
|
|
|
|
|
|
</Step>
|
|
<Step title="Service Principal Secret">
|
|
Copy your service principal **Secret** and **Client ID** for use in the following steps.
|
|
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Accordion title="Configure Permissions for Secret Rotation">
|
|
<Steps>
|
|
<Step title="Add Service Principal to Admin Group">
|
|
Navigate to **Settings** > **Identity & Access** > **Groups** and select the admin group (typically named "admins" or "workspace-admins").
|
|
|
|
|
|
|
|
Click **Add** and select the service principal you created for KMS to add it to the admin group.
|
|
|
|
|
|
|
|
</Step>
|
|
<Step title="Grant Manage Permission for Target Service Principals">
|
|
For each service principal whose secrets you want to rotate, navigate to **Settings** > **Identity & Access** > **Service Principals** and select the target service principal.
|
|
|
|
|
|
</Step>
|
|
<Step title="Open Permissions Tab">
|
|
Click on the **Permissions** tab for the selected service principal. And then click the **Grant access** button to open the permission modal
|
|
|
|
|
|
</Step>
|
|
<Step title="Grant Manage Permission to KMS Service Principal">
|
|
In the **User, Group or Service Principal** field, select the service principal you created for KMS. In the **Permission** field, select **Manage** to allow the KMS service principal to manage credentials and secrets for this service principal. Click **Save** to apply the permissions. Repeat these steps for each service principal whose secrets you want to rotate.
|
|
|
|
|
|
</Step>
|
|
</Steps>
|
|
</Accordion>
|
|
|
|
## Setup Databricks Connection in KMS
|
|
|
|
<Steps>
|
|
<Step title="Navigate to App Connections">
|
|
Navigate to the **Integrations** tab in the desired project, then select **App Connections**. 
|
|
</Step>
|
|
<Step title="Add Connection">
|
|
Select the **Databricks Connection** option from the connection options modal.
|
|
|
|
</Step>
|
|
<Step title="Authorize Connection">
|
|
Select the **Service Principal** method, add your **workspace URL** and **service principal credentials**, then click **Connect to
|
|
Databricks**. 
|
|
</Step>
|
|
<Step title="Connection Created">
|
|
Your **Databricks Connection** is now available for use. 
|
|
</Step>
|
|
</Steps>
|