-
Notifications
You must be signed in to change notification settings - Fork 976
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'current' into runleonarun-patch-15
- Loading branch information
Showing
12 changed files
with
99 additions
and
17 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
80 changes: 80 additions & 0 deletions
80
website/docs/docs/cloud/dbt-cloud-ide/git-commit-signing.md
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,80 @@ | ||
--- | ||
title: "Git commit signing" | ||
description: "Learn how to sign your Git commits when using the IDE for development." | ||
sidebar_label: Git commit signing | ||
--- | ||
|
||
# Git commit signing <Lifecycle status="Enterprise" /> | ||
|
||
To prevent impersonation and enhance security, you can sign your Git commits before pushing them to your repository. Using your signature, a Git provider can cryptographically verify a commit and mark it as "verified", providing increased confidence about its origin. | ||
|
||
You can configure dbt Cloud to sign your Git commits when using the IDE for development. To set up, enable the feature in dbt Cloud, follow the flow to generate a keypair, and upload the public key to your Git provider to use for signature verification. | ||
|
||
|
||
## Prerequisites | ||
|
||
- GitHub or GitLab is your Git provider. Currently, Azure DevOps is not supported. | ||
- You have a dbt Cloud account on the [Enterprise plan](https://www.getdbt.com/pricing/). | ||
|
||
## Generate GPG keypair in dbt Cloud | ||
|
||
To generate a GPG keypair in dbt Cloud, follow these steps: | ||
1. Go to your **Personal profile** page in dbt Cloud. | ||
2. Navigate to **Signed Commits** section. | ||
3. Enable the **Sign commits originating from this user** toggle. | ||
4. This will generate a GPG keypair. The private key will be used to sign all future Git commits. The public key will be displayed, allowing you to upload it to your Git provider. | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/example-git-signed-commits-setting.png" width="95%" title="Example of profile setting Signed commits" /> | ||
|
||
## Upload public key to Git provider | ||
|
||
To upload the public key to your Git provider, follow the detailed documentation provided by the supported Git provider: | ||
|
||
- [GitHub instructions](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account) | ||
- [GitLab instructions](https://docs.gitlab.com/ee/user/project/repository/signed_commits/gpg.html) | ||
|
||
Once you have uploaded the public key to your Git provider, your Git commits will be marked as "Verified" after you push the changes to the repository. | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/git-sign-verified.jpg" width="95%" title="Example of a verified Git commit in a Git provider." /> | ||
|
||
## Considerations | ||
|
||
- The GPG keypair is tied to the user, not a specific account. There is a 1:1 relationship between the user and keypair. The same key will be used for signing commits on any accounts the user is a member of. | ||
- The GPG keypair generated in dbt Cloud is linked to the email address associated with your account at the time of keypair creation. This email identifies the author of signed commits. | ||
- For your Git commits to be marked as "verified", your dbt Cloud email address must be a verified email address with your Git provider. The Git provider (such as, GitHub, GitLab) checks that the commit's signed email matches a verified email in your Git provider account. If they don’t match, the commit won't be marked as "verified." | ||
- Keep your dbt Cloud email and Git provider's verified email in sync to avoid verification issues. If you change your dbt Cloud email address: | ||
- Generate a new GPG keypair with the updated email, following the [steps mentioned earlier](/docs/cloud/dbt-cloud-ide/git-commit-signing#generate-gpg-keypair-in-dbt-cloud). | ||
- Add and verify the new email in your Git provider. | ||
|
||
<!-- vale off --> | ||
|
||
## FAQs | ||
|
||
<!-- vale on --> | ||
|
||
<DetailsToggle alt_header="What happens if I delete my GPG keypair in dbt Cloud?"> | ||
|
||
If you delete your GPG keypair in dbt Cloud, your Git commits will no longer be signed. You can generate a new GPG keypair by following the [steps mentioned earlier](/docs/cloud/dbt-cloud-ide/git-commit-signing#generate-gpg-keypair-in-dbt-cloud). | ||
</DetailsToggle> | ||
|
||
<DetailsToggle alt_header="What Git providers support GPG keys?"> | ||
|
||
GitHub and GitLab support commit signing, while Azure DevOps does not. Commit signing is a [git feature](https://git-scm.com/book/ms/v2/Git-Tools-Signing-Your-Work), and is independent of any specific provider. However, not all providers support the upload of public keys, or the display of verification badges on commits. | ||
|
||
</DetailsToggle> | ||
|
||
<DetailsToggle alt_header="What if my Git provider doesn't support GPG keys?"> | ||
|
||
If your Git Provider does not explicitly support the uploading of public GPG keys, then | ||
commits will still be signed using the private key, but no verification information will | ||
be displayed by the provider. | ||
|
||
</DetailsToggle> | ||
|
||
<DetailsToggle alt_header="What if my Git provider requires that all commits are signed?"> | ||
|
||
If your Git provider is configured to enforce commit verification, then unsigned commits | ||
will be rejected. To avoid this, ensure that you have followed all previous steps to generate | ||
a keypair, and uploaded the public key to the provider. | ||
|
||
</DetailsToggle> |
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 |
---|---|---|
|
@@ -23,7 +23,7 @@ You can receive email alerts about jobs by configuring the dbt Cloud email notif | |
|
||
### Configure email notifications | ||
|
||
1. From the gear menu, choose **Notification settings**. | ||
1. Select your profile icon and then click **Notification settings**. | ||
1. By default, dbt Cloud sends notifications to the email address that's in your **User profile** page. | ||
|
||
If you're an account admin, you can choose a different email address to receive notifications. Select the **Notification email** dropdown and choose another address from the list. The list includes **Internal Users** with access to the account and **External Emails** that have been added. | ||
|
@@ -44,12 +44,12 @@ You can receive email alerts about jobs by configuring the dbt Cloud email notif | |
<Lightbox src="/img/docs/deploy/example-email-notification-settings-page.png" width="100%" title="Example of the Email notifications page"/> | ||
|
||
### Unsubscribe from email notifications | ||
1. From the gear menu, choose **Notification settings**. | ||
1. Select your profile icon and click on **Notification settings**. | ||
1. On the **Email notifications** page, click **Unsubscribe from all email notifications**. | ||
|
||
## Slack notifications | ||
|
||
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. | ||
You can receive Slack alerts about jobs by setting up the Slack integration and 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. | ||
|
@@ -62,7 +62,7 @@ If there has been a change in user roles or Slack permissions where you no longe | |
|
||
### Set up the Slack integration | ||
|
||
1. From the gear menu, select **Account settings** and then select **Integrations** from the left sidebar. | ||
1. 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"/> | ||
|
||
|
@@ -76,13 +76,13 @@ If you're logged out or the Slack app/website is closed, you must authenticate b | |
|
||
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="60%" title="Define the workspace"/> | ||
2. Sign in with an existing identity or use email address and password. | ||
2. Sign in with an existing identity or use the email address and password. | ||
3. Once you have authenticated successfully, accept the permissions. | ||
<Lightbox src="/img/docs/dbt-cloud/accept-permissions.png" width="65%" title="Allow dbt access to Slack"/> | ||
|
||
### Configure Slack notifications | ||
|
||
1. From the gear menu, choose **Notification settings**. | ||
1. Select your profile icon and then click on **Notification settings**. | ||
1. Select **Slack notifications** in the left sidebar. | ||
1. Select the **Notification channel** you want to receive the job run notifications from the dropdown. | ||
<Lightbox src="/img/docs/deploy/example-notification-slack-channels.png" width="100%" title="Example of the Notification channel dropdown"/> | ||
|
@@ -98,5 +98,5 @@ If you're logged out or the Slack app/website is closed, you must authenticate b | |
|
||
### Disable the Slack integration | ||
|
||
1. From the gear menu, select **Account settings**. On the **Integrations** page, scroll to the **OAuth** section. | ||
1. Select **Account settings** and 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. |
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
Binary file modified
BIN
-37.3 KB
(87%)
website/static/img/docs/dbt-cloud/cloud-ide/ide-options-menu-with-save.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+13.6 KB
(180%)
website/static/img/docs/dbt-cloud/cloud-ide/restart-ide.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+154 KB
website/static/img/docs/dbt-cloud/example-git-signed-commits-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.