Skip to content

Commit 8e78239

Browse files
authored
added docs for dremio cloud (#1979)
1 parent 68cb0d9 commit 8e78239

File tree

8 files changed

+114
-2
lines changed

8 files changed

+114
-2
lines changed

docs/_snippets/cloud/integrations/cards-groups/connect-dwh-cards.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,30 @@
288288
}
289289
>
290290
</Card>
291+
<Card
292+
title="Dremio"
293+
href="/cloud/integrations/dwh/dremio"
294+
icon={
295+
<svg
296+
width="41"
297+
height="41"
298+
viewBox="0 0 200 200"
299+
fill="none"
300+
xmlns="http://www.w3.org/2000/svg"
301+
xml:space="preserve"
302+
>
303+
<path d="M46.939 126.15c-5.924 2.687-17.453 8.7-16.36 15.218 1.504 4.006 6.199-.228 7.931-1.914 3.736-3.509 6.697-8.384 8.429-13.304m35.36-14.397c-3.918 10.251-15.356 15.127-18.545 13.396-1.596-.867.136-4.101.181-6.333-2.324.91-6.152 2.596-8.476 3.553 5.56 4.145 8.431 11.299 8.386 18.088 0 6.969-2.87 13.393-8.248 17.813 9.569 14.167 4.696 26.376-8.475 35.899l-.821.547-.274-.956c-1.957-6.743-4.42-12.438-9.068-17.815-2.324-2.687-4.968-5.148-7.564-7.608-3.417-3.235-6.697-6.513-9.797-10.021-13.032-13.851-18.183-37.86-16.495-56.403.864-9.567 3.783-18.724 8.247-27.199 3.555-6.742 8.065-12.938 13.261-18.494 11.483-12.303 26.703-22.008 42.88-26.791 14.216-4.235 30.483-4.965 44.019 2.005 2.187 1.139 5.468 3.143 7.291 4.647 1.141 1.047 2.277 2.141 3.372 3.189.136.091.274.228.365.363l63.295-32.3c5.238-2.596 9.157-2.596 10.753-.727 1.868 2.186-.728 6.74-4.419 9.43l-54.228 39.362c.956 3.143-.638 7.699-3.009 10.387 7.248 2.505.867 13.12-2.323 16.903-9.068 10.752-25.7 19.18-40.509 25.33-3.965 1.686-6.243 2.416-9.799 3.735" fill="#393c42"/>
304+
<path d="M131.924 74.624c4.056-5.103 1.231-8.064-1.595-5.193-5.56 5.693-13.989 7.652-21.598 6.422-11.122-1.868-11.619-3.553-9.752-5.194 13.124 4.785 28.388-1.456 34.721-11.799 2.735-3.917-6.424-7.061-11.845-14.396C95.925 9.475 14.768 40 7.021 101.185c-2.37 18.404 2.779 38.768 15.45 53.119 9.476 10.753 19.774 15.219 25.606 32.121 11.348-9.75 9.57-20.774 1.279-30.433 14.169-7.381 12.119-26.563 2.14-32.393-4.647 17.084-21.327 29.704-25.2 17.585-2.505-12.347 17.819-20.545 50.399-32.892 27.25-10.207 44.84-18.635 55.229-33.668" fill="#55bfce"/>
305+
<path d="M131.924 74.624c4.056-5.103 1.231-8.064-1.595-5.193-4.782 4.92-11.984 7.062-18.546 6.742-11.21-.82-20.142-3.006-28.343-2.142-16.133 1.64-31.853 11.845-40.283 20.456-14.217 14.58-29.893 44.829-14.08 50.708-1.185-.731-2.142-2.051-2.781-4.011-2.505-12.347 17.819-20.545 50.399-32.892 27.25-10.207 44.84-18.635 55.229-33.668" fill="#fff"/>
306+
<path d="M62.157 98.496c8.386 4.1 6.7 18.496 5.47 22.098 15.902-4.512 11.164-28.064 18.548-35.264-9.252-.274-26.57 9.02-24.018 13.166" fill="#55bfce"/>
307+
<path d="M89.045 55.853c2.277-1.184 5.058-.364 6.289 1.915 1.184 2.232.317 5.01-1.916 6.241-2.232 1.184-5.056.363-6.243-1.913-1.229-2.234-.364-5.012 1.87-6.243" fill="#393c42"/>
308+
<path d="m127.641 57.812 63.796-44.42c1.776-1.274 4.148-4.009 3.189-5.33-.955-1.32-3.736-.592-6.105.456l-68.994 37.266c-2.23 4.647 2.28 14.443 8.114 12.028" fill="#55bfce"/>
309+
<path d="m122.036 49.02 66.667-39.225c2.916-1.732 4.056-1.687 5.83-1.87-1.001-1.137-3.736-.454-6.013.592l-68.992 37.267c-1.684 3.508.503 10.024 4.193 11.892-1.321-2.871-2.186-5.877-1.685-8.656" fill="#fff"/>
310+
<path d="M23.836 66.468c2.186-.364 3.874 1.14 3.828 3.374 0 2.23-1.776 4.328-3.963 4.692-2.143.362-3.831-1.14-3.783-3.327 0-2.232 1.775-4.328 3.918-4.739M36.778 52.208c1.914-.318 3.417 1.003 3.37 2.963-.045 2.005-1.594 3.825-3.508 4.191-1.913.32-3.418-1.003-3.372-2.962.046-1.958 1.595-3.828 3.51-4.192M75.921 33.348c1.96.091 3.144 1.731 2.643 3.644-.456 1.915-2.415 3.372-4.328 3.28-1.918-.09-3.1-1.732-2.644-3.644.454-1.914 2.414-3.372 4.329-3.28M87.905 31.389c1.595.364 2.368 1.821 1.732 3.37-.639 1.503-2.461 2.462-4.009 2.142-1.595-.364-2.372-1.823-1.734-3.371.638-1.503 2.46-2.461 4.011-2.141M36.915 61.138c1.41-.228 2.552.774 2.505 2.233 0 1.457-1.185 2.824-2.597 3.053-1.412.274-2.506-.729-2.506-2.188.046-1.457 1.184-2.825 2.598-3.098M16.727 77.903c1.459-.272 2.644.775 2.599 2.28 0 1.548-1.23 2.96-2.69 3.233-1.504.228-2.644-.774-2.644-2.277.048-1.549 1.231-3.007 2.735-3.236M136.026 36.901l-2.96 1.594c.225 4.328 3.78 9.568 6.33 10.434-2.004-3.052-3.825-8.339-3.37-12.028m15.902-8.61-2.596 1.412c.319 3.872 3.508 8.519 5.103 8.792-1.231-1.866-2.825-7.06-2.507-10.204m15.722-8.52-2.006 1.094c-.045 2.55 1.824 6.377 3.918 6.925-1.002-1.595-2.232-4.876-1.912-8.019m15.129-8.154-1.733.956c.138 1.686 2.097 4.829 3.19 5.33-.41-1.229-1.64-3.734-1.457-6.286" fill="#25abad"/>
311+
</svg>
312+
313+
}
314+
></Card>
291315
<Card
292316
title="ClickHouse"
293317
href="/cloud/integrations/dwh/clickhouse"
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
**Note:** We currently support **Dremio Cloud only**. If you are using Dremio Software, please contact us for assistance.
2+
3+
### Create a user for Elementary cloud
4+
5+
Create an email account for the Elementary user.
6+
Example: **elementary@your-organization.com**
7+
8+
On your dbt project, run:
9+
10+
```bash
11+
## Print the query you should run to generate a user.
12+
dbt run-operation create_elementary_user --args '{user: the_mail_of_the_elementary_user}'
13+
```
14+
15+
This command will generate a query to create a user with the necessary permissions. Run this query on your data warehouse with admin permissions to create the user. It will send an email invitation, you need to accept that invitation.
16+
17+
After the invitation was accepted, you need to sign in to Dremio as the Elementary user, and open the Account Settings (bottom-left corner in the Dremio UI):
18+
19+
<img
20+
src="/pics/cloud/dremio/account-settings.png"
21+
alt="Dremio Account Settings"
22+
/>
23+
24+
Click **Generate Token**:
25+
26+
<img
27+
src="/pics/cloud/dremio/generate-token.png"
28+
alt="Generate Token in Dremio"
29+
/>
30+
31+
Set the **maximum lifetime** allowed by Dremio (currently **180 days**).
32+
33+
⚠️ Put a reminder to renew the token before it expires.
34+
35+
You can update the token in Elementary's UI at any time.
36+
37+
### Permissions and security
38+
39+
Elementary cloud doesn't require read permissions to your tables and schemas, but only the following:
40+
41+
- Read-only access to the elementary schema.
42+
- Access to read metadata in information schema and query history, related to the tables in your dbt project.
43+
44+
It is recommended to create a user using the instructions specified above to avoid granting excess privileges. For more details, refer to
45+
46+
[**security and privacy**](https://docs.elementary-data.com/cloud/general/security-and-privacy)
47+
48+
### Fill the connection form
49+
50+
Provide the following fields:
51+
52+
- **Host:**
53+
- US: `api.dremio.cloud`
54+
- EU: `api.eu.dremio.cloud`
55+
- **Object Storage:** Name of the object storage where the Elementary schema is stored.
56+
- **Object Storage Path:** Path inside the object storage where the Elementary schema is stored.
57+
- **Project ID:** Your Dremio Cloud project ID.
58+
- **User:** The email address of the Elementary user.
59+
- **Token:** The token you generated for the Elementary user.
60+
61+
<img
62+
src="/pics/cloud/dremio/dremio-form.png"
63+
alt="Dremio connection form"
64+
/>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Connect to Dremio"
3+
sidebarTitle: "Dremio"
4+
---
5+
6+
<Snippet file="cloud/integrations/dremio.mdx" />
7+
<Snippet file="cloud/integrations/onboarding-help.mdx" />

docs/docs.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,9 @@
179179
"cloud/integrations/dwh/databricks",
180180
"cloud/integrations/dwh/postgres",
181181
"cloud/integrations/dwh/athena",
182-
"cloud/integrations/dwh/trino",
183-
"cloud/integrations/dwh/clickhouse"
182+
"cloud/integrations/dwh/dremio",
183+
"cloud/integrations/dwh/clickhouse",
184+
"cloud/integrations/dwh/trino"
184185
]
185186
},
186187
{

docs/oss/integrations/dremio.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Dremio"
3+
---
4+
5+
<Tabs>
6+
<Tab title="Elementary Cloud">
7+
<Snippet file="cloud/integrations/dremio.mdx" />
8+
</Tab>
9+
<Tab title="Elementary CLI">
10+
<Snippet file="cli/dremio-cli.mdx" />
11+
</Tab>
12+
</Tabs>
13+
14+
### Have a question?
15+
16+
We are available on [Slack](https://elementary-data.com/community), reach out for any kind of help!
26.6 KB
Loading
131 KB
Loading
177 KB
Loading

0 commit comments

Comments
 (0)