-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into ele-966-add-exposure-data
- Loading branch information
Showing
64 changed files
with
375,825 additions
and
374,948 deletions.
There are no files selected for viewing
22 changes: 12 additions & 10 deletions
22
docs/_snippets/faq/question-tests-configuration-priorities.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,22 @@ | ||
<Accordion title="How test configurations are prioritized?"> | ||
|
||
The configuration of Elementary is dbt native and follows the same priorities of `dbt configuration`. | ||
The more granular and specific configuration overrides the less granular one. | ||
The configuration of Elementary is dbt native and follows the same priorities and inheritance. | ||
The more granular and specific configuration overrides the less granular one. | ||
|
||
Elementary searches and prioritizes configuration in the following order: | ||
|
||
For models: | ||
**For models tests:** | ||
1. Test arguments. | ||
2. Model configuration. | ||
3. Global vars in `dbt_project.yml`. | ||
2. Tests path configuration under `tests` key in `dbt_project.yml`. | ||
3. Model configuration. | ||
4. Path configuration under `models` key in `dbt_project.yml`. | ||
5. Global vars in `dbt_project.yml`. | ||
|
||
For sources: | ||
**For sources tests:** | ||
1. Test arguments. | ||
2. Table configuration. | ||
3. Source configuration. | ||
4. Global vars in `dbt_project.yml`. | ||
|
||
2. Tests path configuration under `tests` key in `dbt_project.yml`. | ||
3. Table configuration. | ||
4. Source configuration. | ||
5. Global vars in `dbt_project.yml`. | ||
|
||
</Accordion> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,9 +45,13 @@ To avoid this sampling, set the var `test_sample_rows_count: 0` in your `dbt_pro | |
|
||
## Compliance | ||
|
||
<Check> | ||
**SOC 2 certification:** Elementary is currently in the process of obtaining SOC2 and ISO27001 compliance. | ||
</Check> | ||
|
||
[Contact us](mailto:[email protected]) for auditing reports and penetration testing results. | ||
|
||
## Have more questions? | ||
|
||
We would be happy to answer! | ||
Reach out to us on [email](mailto:[email protected]) or [Slack](https://join.slack.com/t/elementary-community/shared_invite/zt-1b9vogqmq-y~IRhc2396CbHNBXLsrXcA). | ||
Reach out to us on [email](mailto:[email protected]) or [Slack](https://join.slack.com/t/elementary-community/shared_invite/zt-1b9vogqmq-y~IRhc2396CbHNBXLsrXcA). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,16 @@ | ||
--- | ||
title: "Quickstart: Invite and remove users" | ||
sidebarTitle: "Team settings" | ||
title: "Invite and remove users" | ||
sidebarTitle: "5. Invite users" | ||
--- | ||
|
||
### Invite users | ||
|
||
After you signup, you could invite team members to join you! 🎉 | ||
|
||
On the top left buttun select `Account settings`, and you can invite users on the `Team` screen. | ||
On the top left button select `Account settings`, and you can invite users on the `Team` screen. | ||
|
||
Users you invite will recieve an Email saying you invited them, and will need to accept and activate their account. | ||
|
||
<Frame> | ||
<img src="/pics/cloud/invite_users.png" /> | ||
</Frame> | ||
|
||
|
||
### Remove users | ||
|
||
On the top left buttun select `Account settings`, and select the `Team` screen. | ||
|
||
You can remove users by clicking selecting this option under the user options. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,27 @@ | ||
--- | ||
title: "Connect your data warehouse" | ||
sidebarTitle: "Data warehouse" | ||
sidebarTitle: "4. Connect data warehouse" | ||
--- | ||
|
||
You can connect Elementary to a data warehouse that has an Elementary schema (created by the [Elementary dbt package](/cloud/onboarding/quickstart-dbt-package)). | ||
|
||
Here are the steps needed to enable the connection: | ||
Elementary Cloud needs: | ||
- [`profiles.yml`](/cloud/onboarding/create-profile) with connection details | ||
- Read permissions to the Elementary schema (and not the rest of your data) | ||
- Network access (might require to allowlist Elementary IP address) | ||
|
||
### Authentication and IP Allowlist | ||
|
||
Elementary needs authentication details, permissions to read the Elementary schema (and not the rest of your data), and network access enabled by adding the cloud IPs to your data warehouse allowlist. | ||
|
||
Here are the guides on how to configure these on each supported data warehouse: | ||
|
||
- Bigquery | ||
- Snowflake | ||
- Redshift | ||
- Databricks | ||
- Postgres | ||
|
||
Elementary IP for allowlist: `3.126.156.226` | ||
|
||
### Create a `profiles.yml` file | ||
|
||
You will need to provide the connection and authentication details by uploading a YML file with a connection profile named `elementary`. | ||
The profile needs to point at the database and schema name where your elementary tables are. | ||
|
||
The easiest way to generate the profile is to run the following command within the dbt project where you deployed the elementary dbt package (works in dbt cloud as well): | ||
### Connect Elementary cloud | ||
|
||
```shell | ||
dbt run-operation elementary.generate_elementary_cli_profile | ||
``` | ||
On the `Account settings` under `Integrations`, press `Connect` on the "Connect Your data warehouse" section. | ||
|
||
Save the output to a YML file, update the missing details, and you are ready. | ||
Provide an environment name, select a data warehouse type, and upload the `profiles.yml` file with the `elementary` profile. | ||
|
||
Here are the formats of profile for each supported data warehouse: | ||
|
||
<Snippet file="profiles/all-profiles.mdx" /> | ||
### Allowlist Elementary IP | ||
|
||
Elementary IP for allowlist: `3.126.156.226` | ||
|
||
### Connect Elementary cloud | ||
|
||
On the `Account settings` under `Integrations`, press `Connect` on the "Connect Your data warehouse" section. | ||
### Need help with onboarding? | ||
|
||
Provide an env name, select a data warehouse type, and upload the `profiles.yml` file with the `elementary` profile. | ||
We can provide [support on Slack](https://join.slack.com/t/elementary-community/shared_invite/zt-1b9vogqmq-y~IRhc2396CbHNBXLsrXcA) or hop on an [onboarding call](https://savvycal.com/MaayanSa/df29881c). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
--- | ||
title: "Create `profiles.yml` file" | ||
sidebarTitle: "2. Create profiles.yml" | ||
--- | ||
|
||
You will need to provide Elementary cloud a `profiles.yml` file with a connection profile named `elementary`. | ||
|
||
- The profile needs to point at the database and schema name where your elementary tables are. | ||
- The provided credentials need to have read permissions to the elementary schema. | ||
|
||
The easiest way to generate the profile is: | ||
1. Run the following command in the dbt project where elementary dbt package is deployed (works in dbt cloud as well): | ||
|
||
```shell | ||
dbt run-operation elementary.generate_elementary_cli_profile | ||
``` | ||
|
||
2. Copy and save the output to a `profiles.yml` file, update the missing details, and you are ready. | ||
|
||
### Permissions and security | ||
|
||
**Elementary cloud doesn't need permissions to your sensitive data.** | ||
|
||
It is recommended to create a read only user for the elementary schema only, and provide it to Elementary Cloud in the profile. | ||
For more details, refer to [security and privacy](/cloud/security-and-privacy). | ||
|
||
### `profiles.yml` examples | ||
|
||
Here is the format of `profiles.yml` for each supported data warehouse: | ||
|
||
<CodeGroup> | ||
|
||
```yml Snowflake | ||
## SNOWFLAKE ## | ||
## Configure the database and schema of elementary models. | ||
|
||
elementary: | ||
outputs: | ||
default: | ||
type: snowflake | ||
account: [account id] | ||
|
||
## User/password auth ## | ||
user: [username] | ||
password: [password] | ||
|
||
port: 5439 | ||
role: [user role] | ||
database: [database name] | ||
warehouse: [warehouse name] | ||
schema: [schema name]_elementary | ||
threads: 4 | ||
|
||
``` | ||
|
||
```yml BigQuery | ||
## BIGQUERY ## | ||
## Configure the database and schema of elementary models. | ||
|
||
elementary: | ||
outputs: | ||
default: | ||
type: bigquery | ||
|
||
## Service account auth ## | ||
method: service-account | ||
keyfile: empty | ||
|
||
project: [project id] | ||
dataset: [dataset name] # elementary dataset, usually [dataset name]_elementary | ||
threads: 4 | ||
location: [dataset location] | ||
priority: interactive | ||
``` | ||
```yml Redshift | ||
## REDSHIFT ## | ||
## Configure the database and schema of elementary models. | ||
|
||
elementary: | ||
outputs: | ||
default: | ||
type: redshift | ||
host: [hostname, like hostname.region.redshift.amazonaws.com] | ||
|
||
## User/password auth ## | ||
user: [username] | ||
password: [password] | ||
|
||
dbname: [database name] | ||
schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
threads: 4 | ||
``` | ||
```yml Databricks | ||
## DATABRICKS ## | ||
## Configure the database and schema of elementary models. | ||
|
||
elementary: | ||
outputs: | ||
default: | ||
type: databricks | ||
host: [hostname, like <ID>.cloud.databricks.com] | ||
http_path: [like /sql/1.0/endpoints/<ID>] | ||
schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
token: [token] | ||
threads: [number of threads like 8] | ||
``` | ||
```yml Postgres | ||
## POSTGRES ## | ||
## Configure the database and schema of elementary models. | ||
|
||
elementary: | ||
outputs: | ||
default: | ||
type: postgres | ||
host: [hostname] | ||
user: [username] | ||
password: [password] | ||
port: [port] | ||
dbname: [database name] | ||
schema: [schema name] # elementary schema, usually [schema name]_elementary | ||
threads: [1 or more] | ||
|
||
``` | ||
|
||
</CodeGroup> | ||
|
||
### What's next? | ||
|
||
1. [Singup to Elementary cloud](/cloud/sonboarding/signup). | ||
2. [Connect your Elementary schema to Elementary cloud](/cloud/onboarding/connect-data-warehouse). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.