-
Notifications
You must be signed in to change notification settings - Fork 969
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'ly-docs-trigger-on-merge' of github.com:dbt-labs/docs.g…
…etdbt.com into ly-docs-trigger-on-merge
- Loading branch information
Showing
24 changed files
with
628 additions
and
90 deletions.
There are no files selected for viewing
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
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 |
---|---|---|
|
@@ -56,3 +56,47 @@ Once dbt Cloud support completes the configuration, you can start creating new c | |
3. Select the private endpoint from the dropdown (this will automatically populate the hostname/account field). | ||
4. Configure the remaining data platform details. | ||
5. Test your connection and save it. | ||
|
||
## Configuring Network Policies | ||
If your organization uses [Snowflake Network Policies](https://docs.snowflake.com/en/user-guide/network-policies) to restrict access to your Snowflake account, you will need to add a network rule for dbt Cloud. | ||
|
||
You can request the VPCE ID from [dbt Cloud Support](mailto:[email protected]), that you can use to create a network policy. | ||
|
||
### Using the UI | ||
|
||
Open the Snowflake UI and take the following steps: | ||
1. Go to the **Security** tab. | ||
2. Click on **Network Rules**. | ||
3. Click on **Add Rule**. | ||
4. Give the rule a name. | ||
5. Select a database and schema where the rule will be stored. These selections are for permission settings and organizational purposes; they do not affect the rule itself. | ||
6. Set the type to `AWS VPCE ID` and the mode to `Ingress`. | ||
7. Type the VPCE ID provided by dbt Cloud Support into the identifier box and press **Enter**. | ||
8. Click **Create Network Rule**. | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/snowflakeprivatelink2.png" title="Create Network Rule"/> | ||
|
||
9. In the **Network Policy** tab, edit the policy you want to add the rule to. This could be your account-level policy or a policy specific to the users connecting from dbt Cloud. | ||
|
||
|
||
10. Add the new rule to the allowed list and click **Update Network Policy**. | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/snowflakeprivatelink3.png" title="Update Network Policy"/> | ||
|
||
### Using SQL | ||
For quick and automated setup of network rules via SQL in Snowflake, the following commands allow you to create and configure access rules for dbt Cloud. These SQL examples demonstrate how to add a network rule and update your network policy accordingly. | ||
|
||
1. Create a new network rule with the following SQL: | ||
```sql | ||
CREATE NETWORK RULE allow_dbt_cloud_access | ||
MODE = INGRESS | ||
TYPE = AWSVPCEID | ||
VALUE_LIST = ('<VPCE_ID>'); -- Replace '<VPCE_ID>' with the actual ID provided | ||
``` | ||
|
||
2. Add the rule to a network policy with the following SQL: | ||
```sql | ||
ALTER NETWORK POLICY <network_policy_name> | ||
ADD ALLOWED_NETWORK_RULE_LIST =('allow_dbt_cloud_access'); | ||
``` | ||
|
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
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 |
---|---|---|
|
@@ -43,7 +43,7 @@ You can receive email alerts about jobs by configuring the dbt Cloud email notif | |
|
||
## Slack notifications | ||
|
||
You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings. | ||
You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings. dbt Cloud integrates with Slack via OAuth to ensure secure authentication. | ||
|
||
:::note | ||
If there has been a change in user roles or Slack permissions where you no longer have access to edit a configured Slack channel, please [contact support](mailto:[email protected]) for assistance. | ||
|
@@ -52,16 +52,28 @@ If there has been a change in user roles or Slack permissions where you no longe | |
### Prerequisites | ||
- You must be an administrator of the Slack workspace. | ||
- You must be an account admin to configure Slack notifications in dbt Cloud. For more details, refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users). | ||
- Make sure the notification channel (where you want to receive alerts) is a public channel. The integration only supports public channels in the Slack workspace. | ||
- The integration only supports _public_ channels in the Slack workspace. | ||
|
||
### Set up the Slack integration | ||
|
||
1. From the gear menu, select **Profile settings**. On your **User profile** page, scroll to the **Linked accounts** section. | ||
1. In the **Linked accounts** section, find the Slack application and click **Link**. | ||
1. From the gear menu, select **Account settings** and then select **Integrations** from the left sidebar. | ||
1. Locate the **OAuth** section with the Slack application and click **Link**. | ||
<Lightbox src="/img/docs/dbt-cloud/Link-your-Slack-Profile.png" width="75%" title="Link for the Slack app"/> | ||
1. Allow dbt Labs to access the Slack workspace. If you are a member of multiple workspaces, you can select the appropriate workspace from the dropdown menu in the upper right corner. | ||
|
||
### Logged in to Slack | ||
If you're already logged in to Slack, the handshake only requires allowing the app access. If you're a member of multiple workspaces, you can select the appropriate workspace from the dropdown menu in the upper right corner. | ||
<Lightbox src="/img/docs/dbt-cloud/Allow-dbt-to-access-slack.png" width="75%" title="Allow dbt access to Slack"/> | ||
|
||
## Logged out | ||
|
||
If you're logged out or the Slack app/website is closed, you must authenticate before completing the integration. | ||
|
||
1. Complete the field defining the Slack workspace you want to integrate with dbt Cloud. | ||
<Lightbox src="/img/docs/dbt-cloud/define-workspace.png" width="75%" title="Define the workspace"/> | ||
2. Sign in with an existing identity or use email address and password. | ||
3. Once you have authenticated successfully, accept the permissions. | ||
<Lightbox src="/img/docs/dbt-cloud/accept-permissions.png" width="75%" title="Allow dbt access to Slack"/> | ||
|
||
### Configure Slack notifications | ||
|
||
1. From the gear menu, choose **Notification settings**. | ||
|
@@ -80,5 +92,5 @@ If there has been a change in user roles or Slack permissions where you no longe | |
|
||
### Disable the Slack integration | ||
|
||
1. From the gear menu, select **Profile settings**. On your **User profile** page, scroll to the **Linked accounts** section. | ||
1. Find the Slack application in the **Linked accounts** section, click the trash can icon, and click **Unlink**. Channels that you configured will no longer receive Slack notifications. Channels that are configured by other account admins will continue to receive Slack notifications if they still have active Slack integrations. To migrate ownership of a Slack channel notification configuration, have another account admin edit the configuration. | ||
1. From the gear menu, select **Account settings**. On the **Integrations** page, scroll to the **OAuth** section. | ||
1. Click the trash can icon (on the far right of the Slack integration) and click **Unlink**. Channels that you configured will no longer receive Slack notifications. _This is not an account-wide action._ Channels configured by other account admins will continue to receive Slack notifications if they still have active Slack integrations. To migrate ownership of a Slack channel notification configuration, have another account admin edit their configuration. |
Oops, something went wrong.