mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
feature: databricks sync
This commit is contained in:
Scott Wilson
@@ -62,7 +62,7 @@ Infisical currently only supports one method for connecting to Azure, which is O
|
||||
## Setup Azure Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the App Connections">
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page. 
|
||||
</Step>
|
||||
|
||||
@@ -61,7 +61,7 @@ Infisical currently only supports one method for connecting to Azure, which is O
|
||||
## Setup Azure Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the App Connections">
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page. 
|
||||
</Step>
|
||||
|
||||
64
docs/integrations/app-connections/databricks.mdx
Normal file
64
docs/integrations/app-connections/databricks.mdx
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: "Databricks Connection"
|
||||
description: "Learn how to configure a Databricks Connection for Infisical."
|
||||
---
|
||||
|
||||
Infisical 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 Infisical
|
||||
|
||||
<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 Infisical.
|
||||
|
||||
|
||||
</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>
|
||||
|
||||
## Setup Databricks Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings**
|
||||
page. 
|
||||
</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>
|
||||
@@ -81,7 +81,7 @@ Infisical supports [service account impersonation](https://cloud.google.com/iam/
|
||||
## Setup GCP Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the App Connections">
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings**
|
||||
page. 
|
||||
|
||||
@@ -69,7 +69,7 @@ Infisical supports two methods for connecting to GitHub.
|
||||
## Setup GitHub Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the App Connections">
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page.
|
||||
|
||||
</Step>
|
||||
@@ -135,7 +135,7 @@ Infisical supports two methods for connecting to GitHub.
|
||||
## Setup GitHub Connection in Infisical
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the App Connections">
|
||||
<Step title="Navigate to App Connections">
|
||||
Navigate to the **App Connections** tab on the **Organization Settings** page.
|
||||
|
||||
</Step>
|
||||
|
||||
140
docs/integrations/secret-syncs/databricks.mdx
Normal file
140
docs/integrations/secret-syncs/databricks.mdx
Normal file
@@ -0,0 +1,140 @@
|
||||
---
|
||||
title: "Databricks Sync"
|
||||
description: "Learn how to configure a Databricks Sync for Infisical."
|
||||
---
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
- Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
|
||||
- Create a [Databricks Connection](/integrations/app-connections/databricks)
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Infisical UI">
|
||||
1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
|
||||
|
||||
|
||||
2. Select the **Databricks** option.
|
||||
|
||||
|
||||
3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
|
||||
|
||||
|
||||
- **Environment**: The project environment to retrieve secrets from.
|
||||
- **Secret Path**: The folder path to retrieve secrets from.
|
||||
|
||||
<Tip>
|
||||
If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
|
||||
</Tip>
|
||||
|
||||
4. Configure the **Destination** to where secrets should be deployed, then click **Next**.
|
||||
|
||||
|
||||
- **Databricks Connection**: The Databricks Connection to authenticate with.
|
||||
- **Scope**: The Databricks secret scope to sync secrets to.
|
||||
|
||||
<Note>
|
||||
You must create a secret scope in your Databricks workspace prior to configuration. Ensure your service principal has [Write permissions](https://docs.databricks.com/en/security/auth/access-control/index.html#secret-acls) for the specified secret scope.
|
||||
</Note>
|
||||
|
||||
5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
|
||||
|
||||
|
||||
- **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
|
||||
- **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
|
||||
<Note>
|
||||
Databricks does not support importing secrets.
|
||||
</Note>
|
||||
- **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
|
||||
|
||||
6. Configure the **Details** of your Databricks Sync, then click **Next**.
|
||||
|
||||
|
||||
- **Name**: The name of your sync. Must be slug-friendly.
|
||||
- **Description**: An optional description for your sync.
|
||||
|
||||
7. Review your Databricks Sync configuration, then click **Create Sync**.
|
||||
|
||||
|
||||
8. If enabled, your Databricks Sync will begin syncing your secrets to the destination endpoint.
|
||||
|
||||
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
To create an **Databricks Sync**, make an API request to the [Create Databricks Sync](/api-reference/endpoints/secret-syncs/databricks/create) API endpoint.
|
||||
|
||||
### Sample request
|
||||
|
||||
```bash Request
|
||||
curl --request POST \
|
||||
--url https://app.infisical.com/api/v1/secret-syncs/databricks \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"name": "my-databricks-sync",
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"description": "an example sync",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"environment": "dev",
|
||||
"secretPath": "/my-secrets",
|
||||
"isEnabled": true,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination"
|
||||
},
|
||||
"destinationConfig": {
|
||||
"scope": "my-scope"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
||||
```bash Response
|
||||
{
|
||||
"secretSync": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"name": "my-databricks-sync",
|
||||
"description": "an example sync",
|
||||
"isEnabled": true,
|
||||
"version": 1,
|
||||
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"createdAt": "2023-11-07T05:31:56Z",
|
||||
"updatedAt": "2023-11-07T05:31:56Z",
|
||||
"syncStatus": "succeeded",
|
||||
"lastSyncJobId": "123",
|
||||
"lastSyncMessage": null,
|
||||
"lastSyncedAt": "2023-11-07T05:31:56Z",
|
||||
"importStatus": null,
|
||||
"lastImportJobId": null,
|
||||
"lastImportMessage": null,
|
||||
"lastImportedAt": null,
|
||||
"removeStatus": null,
|
||||
"lastRemoveJobId": null,
|
||||
"lastRemoveMessage": null,
|
||||
"lastRemovedAt": null,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination"
|
||||
},
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connection": {
|
||||
"app": "databricks",
|
||||
"name": "my-databricks-connection",
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
||||
},
|
||||
"environment": {
|
||||
"slug": "dev",
|
||||
"name": "Development",
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
||||
},
|
||||
"folder": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"path": "/my-secrets"
|
||||
},
|
||||
"destination": "databricks",
|
||||
"destinationConfig": {
|
||||
"scope": "my-scope"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
Reference in New Issue
Block a user