Skip to content

Commit e02b579

Browse files
tgberkeleyElijahAhianyomasenfcarlosabadiadevin-ai-integration[bot]
authored
Databricks oauth docs (#1676)
* Remove print statement (#241) * Do not require redis in rxconfig.py (#395) * use rx.color instead of var in icon docs page (#1019) * Revert the last two deploy workflow commits (#1308) * Revert "Fix: Remove interactive flag from deploy workflows (#1307)" This reverts commit 08d1ce0bc34058c489ac580ffde194cfcc45b4ac. * Revert "Fix: Replace --no-interactive with --interactive=false in deploy workflows (#1306)" This reverts commit 55aed9660525cdd3b477a26141ab176640590a7b. --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * oauth databricks docs --------- Co-authored-by: Elijah Ahianyo <[email protected]> Co-authored-by: Masen Furer <[email protected]> Co-authored-by: Carlos <[email protected]> Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Tom Gotsman <[email protected]>
1 parent 6f60fe7 commit e02b579

File tree

8 files changed

+145
-5
lines changed

8 files changed

+145
-5
lines changed
15.2 KB
Loading
31.2 KB
Loading
11.2 KB
Loading
9.31 KB
Loading
21.3 KB
Loading
5.51 KB
Loading
18.2 KB
Loading

docs/ai_builder/integrations/databricks.md

Lines changed: 145 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,41 @@ rx.el.div(
5050
)
5151
```
5252

53-
3 - Generate a **Personal Access Token** (**DATABRICKS_TOKEN**):
53+
54+
3 - Get your **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA**:
55+
- Click the SQL Editor from the sidebar.
56+
- Choose the **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA** from the dropdowns as shown below.
57+
58+
59+
```python eval
60+
rx.el.div(
61+
image_zoom(
62+
rx.image(
63+
src="/ai_builder/integrations/databricks_integration_4.webp",
64+
class_name="p-2 rounded-md h-auto",
65+
border=f"0.81px solid {rx.color('slate', 5)}",
66+
),
67+
class_name="rounded-md overflow-hidden",
68+
),
69+
class_name="w-full flex flex-col rounded-md cursor-pointer",
70+
)
71+
```
72+
73+
```python eval
74+
rx.box(height="2rem")
75+
```
76+
77+
4 - Obtain your authentication credentials:
78+
79+
There are two methods to authenticate your app with Databricks: using a **Personal Access Token** or via **OAuth**. Choose one of the methods below to obtain the necessary credentials.
80+
81+
82+
---md tabs
83+
84+
--tab Personal Access Token
85+
## Generate a Personal Access Token (DATABRICKS_TOKEN)
86+
87+
5488
- Click on your profile icon → **Settings**.
5589
- Click **Developer**.
5690
- Click **Manage** in Access Tokens.
@@ -86,16 +120,21 @@ rx.el.div(
86120
)
87121
```
88122

89-
4 - Get your **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA**:
90-
- Click the SQL Editor from the sidebar.
91-
- Choose the **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA** from the dropdowns as shown below.
123+
124+
125+
126+
--
127+
--tab OAuth
128+
## Use OAuth (DATABRICKS_CLIENT_ID and DATABRICKS_CLIENT_SECRET)
129+
130+
- Open the dropdown in the top right corner and select **Manage Account**.
92131

93132

94133
```python eval
95134
rx.el.div(
96135
image_zoom(
97136
rx.image(
98-
src="/ai_builder/integrations/databricks_integration_4.webp",
137+
src="/ai_builder/integrations/databricks_integration_oauth_1.webp",
99138
class_name="p-2 rounded-md h-auto",
100139
border=f"0.81px solid {rx.color('slate', 5)}",
101140
),
@@ -105,6 +144,107 @@ rx.el.div(
105144
)
106145
```
107146

147+
- Select `Users and Groups`
148+
149+
```python eval
150+
rx.el.div(
151+
image_zoom(
152+
rx.image(
153+
src="/ai_builder/integrations/databricks_integration_oauth_2.webp",
154+
class_name="p-2 rounded-md h-auto",
155+
border=f"0.81px solid {rx.color('slate', 5)}",
156+
),
157+
class_name="rounded-md overflow-hidden",
158+
),
159+
class_name="w-full flex flex-col rounded-md cursor-pointer",
160+
)
161+
```
162+
163+
- Select the `Service Principals` tab and click `Add Service Principal`.
164+
165+
```python eval
166+
rx.el.div(
167+
image_zoom(
168+
rx.image(
169+
src="/ai_builder/integrations/databricks_integration_oauth_3.webp",
170+
class_name="p-2 rounded-md h-auto",
171+
border=f"0.81px solid {rx.color('slate', 5)}",
172+
),
173+
class_name="rounded-md overflow-hidden",
174+
),
175+
class_name="w-full flex flex-col rounded-md cursor-pointer",
176+
)
177+
```
178+
179+
- Fill in the details and click `Add Service Principal`.
180+
181+
```python eval
182+
rx.el.div(
183+
image_zoom(
184+
rx.image(
185+
src="/ai_builder/integrations/databricks_integration_oauth_4.webp",
186+
class_name="p-2 rounded-md h-auto",
187+
border=f"0.81px solid {rx.color('slate', 5)}",
188+
),
189+
class_name="rounded-md overflow-hidden",
190+
),
191+
class_name="w-full flex flex-col rounded-md cursor-pointer",
192+
)
193+
```
194+
195+
- Click the `Credentials and Secrets` tab and click `Generate Secret`.
196+
197+
198+
```python eval
199+
rx.el.div(
200+
image_zoom(
201+
rx.image(
202+
src="/ai_builder/integrations/databricks_integration_oauth_5.webp",
203+
class_name="p-2 rounded-md h-auto",
204+
border=f"0.81px solid {rx.color('slate', 5)}",
205+
),
206+
class_name="rounded-md overflow-hidden",
207+
),
208+
class_name="w-full flex flex-col rounded-md cursor-pointer",
209+
)
210+
```
211+
212+
- Set a lifetime for the secrets and click `Generate`.
213+
214+
```python eval
215+
rx.el.div(
216+
image_zoom(
217+
rx.image(
218+
src="/ai_builder/integrations/databricks_integration_oauth_6.webp",
219+
class_name="p-2 rounded-md h-auto",
220+
border=f"0.81px solid {rx.color('slate', 5)}",
221+
),
222+
class_name="rounded-md overflow-hidden",
223+
),
224+
class_name="w-full flex flex-col rounded-md cursor-pointer",
225+
)
226+
```
227+
228+
- Copy the generated **DATABRICKS_CLIENT_ID** and **DATABRICKS_CLIENT_SECRET**.
229+
230+
```python eval
231+
rx.el.div(
232+
image_zoom(
233+
rx.image(
234+
src="/ai_builder/integrations/databricks_integration_oauth_7.webp",
235+
class_name="p-2 rounded-md h-auto",
236+
border=f"0.81px solid {rx.color('slate', 5)}",
237+
),
238+
class_name="rounded-md overflow-hidden",
239+
),
240+
class_name="w-full flex flex-col rounded-md cursor-pointer",
241+
)
242+
```
243+
244+
--
245+
246+
---
247+
108248

109249

110250
## Step 2: Configure the Integration in Your App

0 commit comments

Comments
 (0)