Skip to content

Commit

Permalink
Merge branch 'current' into ENT-1132-job-runner
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewshaver authored Jan 26, 2024
2 parents 6dce266 + ba1d744 commit 189cbfa
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 38 deletions.
15 changes: 4 additions & 11 deletions website/docs/docs/cloud/manage-access/about-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,10 @@ Cloud administrators can manage access to dbt Cloud resources via identity
management software like Azure AD, Okta, or GSuite. See _SSO Mappings_ below for
more information.

You can view the groups in your account or create new groups from the **Team > Groups**
page in your Account Settings.

<Lightbox
src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/group-list.png"
title="Viewing a list of groups in the Account Settings page."
/>
You can view the groups in your account or create new groups from the **Groups & Licenses**
page in your Account Settings. <br />

<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/group-list-2.png" title="Viewing a list of groups in the Account Settings page." />

### SSO mappings

Expand Down Expand Up @@ -115,10 +111,7 @@ In the following example, the _dbt Cloud Owners_ group is configured with the
**Account Admin** permission set on _All Projects_ and the **Job Admin** permission
set on the _Internal Analytics_ project.

<Lightbox
src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/group-permissions.png"
title="Configuring permissions for the Admins group"
/>
<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/group-permissions.png" width="65%" title="Configuring permissions for the Admins group"/>


### Manual assignment
Expand Down
27 changes: 14 additions & 13 deletions website/docs/docs/cloud/manage-access/cloud-seats-and-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,14 @@ The following tabs detail steps on how to modify your user license count:

If you're on an Enterprise plan and have the correct [permissions](/docs/cloud/manage-access/enterprise-permissions), you can add or remove licenses by adjusting your user seat count. Note, an IT license does not count toward seat usage.

- To remove a user, go to **Account Settings**, select **Users** under **Teams**. Select the user you want to remove, click **Edit**, and then **Delete**. This action cannot be undone. However, you can re-invite the user with the same info if you deleted the user in error.<br />
- To remove a user, go to **Account Settings** and select **Users**.
- Select the user you want to remove, click **Edit**, and then **Delete**.
- This action cannot be undone. However, you can re-invite the user with the same info if you deleted the user in error.<br />

- To add a user, go to **Account Settings**, select **Users** under **Teams**. Select [**Invite Users**](docs/cloud/manage-access/invite-users). For fine-grained permission configuration, refer to [Role based access control](/docs/cloud/manage-access/enterprise-permissions).
- To add a user, go to **Account Settings** and select **Users**.
- Click the [**Invite Users**](/docs/cloud/manage-access/invite-users) button.
- For fine-grained permission configuration, refer to [Role based access control](/docs/cloud/manage-access/enterprise-permissions).

<Lightbox src="/img/docs/dbt-cloud/faq-account-settings-enterprise.jpg" width="85%" title="Navigate to Account Settings --> Users to add or remove users" />

</TabItem>

Expand All @@ -72,14 +75,13 @@ To add a user in dbt Cloud, you must be an account owner or have admin privilege

1. From dbt Cloud, click the gear icon at the top right and select **Account Settings**.

<Lightbox src="/img/docs/dbt-cloud/Navigate To Account Settings.png" width="85%" title="Navigate to Account Settings" />
<Lightbox src="/img/docs/dbt-cloud/Navigate To Account Settings.png" width="75%" title="Navigate to Account Settings" />

2. In **Account Settings**, select **Billing**.
3. Enter the number of developer seats you want and make sure you fill in all the payment details, including the **Billing Address** section. Leaving these blank won't allow you to save your changes.
4. Press **Update Payment Information** to save your changes.

4. Press **Update Payment Information** to save your changes.

<Lightbox src="/img/docs/dbt-cloud/faq-account-settings-billing.jpg" width="85%" title="Navigate to Account Settings -> Billing to modify billing seat count" />
<Lightbox src="/img/docs/dbt-cloud/faq-account-settings-billing.jpg" width="75%" title="Navigate to Account Settings -> Billing to modify billing seat count" />


Now that you've updated your billing, you can now [invite users](/docs/cloud/manage-access/invite-users) to join your dbt Cloud account:
Expand All @@ -95,11 +97,11 @@ To delete a user in dbt Cloud, you must be an account owner or have admin privil

<Lightbox src="/img/docs/dbt-cloud/Navigate To Account Settings.png" width="85%" title="Navigate to Account Settings" />

2. In **Account Settings**, select **Users** under **Teams**.
2. In **Account Settings** and select **Users**.
3. Select the user you want to delete, then click **Edit**.
4. Click **Delete** in the bottom left. Click **Confirm Delete** to immediately delete the user without additional password prompts. This action cannot be undone. However, you can re-invite the user with the same information if the deletion was made in error.

<Lightbox src="/img/docs/dbt-cloud/delete_user_20221023.gif" width="85%" title="Deleting a user" />
<Lightbox src="/img/docs/dbt-cloud/delete_user_20221023.gif" width="75%" title="Deleting a user" />


If you are on a **Teams** plan and you're deleting users to reduce the number of billable seats, follow these steps to lower the license count to avoid being overcharged:
Expand All @@ -108,7 +110,7 @@ If you are on a **Teams** plan and you're deleting users to reduce the number of
2. Enter the number of developer seats you want and make sure you fill in all the payment details, including the **Billing Address** section. If you leave any field blank, you won't be able to save your changes.
3. Click **Update Payment Information** to save your changes.

<Lightbox src="/img/docs/dbt-cloud/faq-account-settings-billing.jpg" width="85%" title="The **Billing** page in your **Account Settings**" />
<Lightbox src="/img/docs/dbt-cloud/faq-account-settings-billing.jpg" width="75%" title="The Billing** page in your **Account Settings" />

Great work! After completing these steps, your dbt Cloud user count and billing count should now be the same.

Expand Down Expand Up @@ -136,7 +138,7 @@ to allocate for the user. If your account does not have an available license to
allocate, you will need to add more licenses to your plan to complete the license
change.

<Lightbox src="/img/docs/dbt-cloud/access-control/license-manual.png" title="Manually assigning licenses"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/license-manual.png" width="55%" title="Manually assigning licenses"/>

### Mapped configuration

Expand All @@ -154,8 +156,7 @@ license. To assign Read-Only licenses to certain groups of users, create a new
License Mapping for the Read-Only license type and include a comma separated
list of IdP group names that should receive a Read-Only license at sign-in time.

<Lightbox src="/img/docs/dbt-cloud/access-control/license-mapping.png"
title="Configuring IdP group license mapping"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/license-mapping.png" width="65%" title="Configuring IdP group license mapping"/>

Usage notes:
- If a user's IdP groups match both a Developer and Read-Only license type
Expand Down
14 changes: 7 additions & 7 deletions website/docs/docs/cloud/manage-access/enterprise-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ The user's [license](/docs/cloud/manage-access/seats-and-users) type always over

Role-Based Access Control (RBAC) is helpful for automatically assigning permissions to dbt admins based on their SSO provider group associations.

1. Click the gear icon to the top right and select **Account Settings**. From the **Team** section, click **Groups**
1. Click the gear icon to the top right and select **Account Settings**. Click **Groups & Licenses**

<Lightbox src="/img/docs/dbt-cloud/Select-Groups-RBAC.png" title="Navigate to Groups"/>
<Lightbox src="/img/docs/dbt-cloud/Select-Groups-RBAC.png" width="70%" title="Navigate to Groups"/>

1. Select an existing group or create a new group to add RBAC. Name the group (this can be any name you like, but it's recommended to keep it consistent with the SSO groups). If you have configured SSO with SAML 2.0, you may have to use the GroupID instead of the name of the group.
2. Configure the SSO provider groups you want to add RBAC by clicking **Add** in the **SSO** section. These fields are case-sensitive and must match the source group formatting.
3. Configure the permissions for users within those groups by clicking **Add** in the **Access** section of the window.
<Lightbox src="/img/docs/dbt-cloud/Configure-SSO-Access.png" title="Configure SSO groups and Access permissions"/>
2. Select an existing group or create a new group to add RBAC. Name the group (this can be any name you like, but it's recommended to keep it consistent with the SSO groups). If you have configured SSO with SAML 2.0, you may have to use the GroupID instead of the name of the group.
3. Configure the SSO provider groups you want to add RBAC by clicking **Add** in the **SSO** section. These fields are case-sensitive and must match the source group formatting.
4. Configure the permissions for users within those groups by clicking **Add** in the **Access** section of the window.
<Lightbox src="/img/docs/dbt-cloud/Configure-SSO-Access.png" width="45%" title="Configure SSO groups and Access permissions"/>

4. When you've completed your configurations, click **Save**. Users will begin to populate the group automatically once they have signed in to dbt Cloud with their SSO credentials.
5. When you've completed your configurations, click **Save**. Users will begin to populate the group automatically once they have signed in to dbt Cloud with their SSO credentials.
12 changes: 6 additions & 6 deletions website/docs/docs/cloud/manage-access/invite-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ id: "invite-users"
sidebar: "Invite users"
---

dbt Cloud makes it easy to invite new users to your environment out of the box. This feature is available to all dbt Cloud customers on Teams or Enteprise plans (Developer plans are limited to a single user).
dbt Cloud makes it easy to invite new users to your environment out of the box. This feature is available to all dbt Cloud customers on Teams or Enterprise plans (Developer plans are limited to a single user).

## Prerequisites

Expand All @@ -24,7 +24,7 @@ You must have proper permissions to invite new users:

3. Click on **Invite Users**.

<Lightbox src="/img/docs/dbt-cloud/access-control/invite-users.png" title="The invite users pane"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/invite-users.png" width="60%" title="The invite users pane"/>

4. In the **Email Addresses** field, enter the email addresses of the users you would like to invite separated by comma, semicolon, or a new line.
5. Select the license type for the batch of users from the **License** dropdown.
Expand All @@ -40,23 +40,23 @@ dbt Cloud generates and sends emails from `[email protected]` to the specified

The email contains a link to create an account. When the user clicks on this they will be brought to one of two screens depending on whether SSO is configured or not.

<Lightbox src="/img/docs/dbt-cloud/access-control/email-invite.png" title="Example or an email invitation"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/email-invite.png" width="60%" title="Example or an email invitation"/>

<Tabs>

<TabItem value="Local user">

The default settings send the email, the user clicks the link, and is prompted to create their account:

<Lightbox src="/img/docs/dbt-cloud/access-control/default-user-invite.png" title="Default user invitation"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/default-user-invite.png" width="60%" title="Default user invitation"/>

</TabItem>

<TabItem value="SSO user">

If SSO is configured for the environment, the user clicks the link, is brought to a confirmation screen, and presented with a link to authenticate against the company's identity provider:

<Lightbox src="/img/docs/dbt-cloud/access-control/sso-user-invite.png" title="User invitation with SSO configured"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/sso-user-invite.png" width="60%" title="User invitation with SSO configured"/>

</TabItem>

Expand All @@ -73,4 +73,4 @@ Once the user completes this process, their email and user information will popu
* What happens if I need to resend the invitation? _From the Users page, click on the invite record, and you will be presented with the option to resend the invitation._
* What can I do if I entered an email address incorrectly? _From the Users page, click on the invite record, and you will be presented with the option to revoke it. Once revoked, generate a new invitation to the correct email address._

<Lightbox src="/img/docs/dbt-cloud/access-control/resend-invite.png" title="Resend or revoke the users invitation"/>
<Lightbox src="/img/docs/dbt-cloud/access-control/resend-invite.png" width="60%" title="Resend or revoke the users invitation"/>
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/grants.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For more information on hooks, see [Hooks & operations](/docs/build/hooks-operat

## Definition

You can use the `grants` field to set permissions or grants for a resource. When you run a model, seed or seed, or snapshot a snapshot, dbt will run `grant` and/or `revoke` statements to ensure that the permissions on the database object match the `grants` you have configured on the resource.
You can use the `grants` field to set permissions or grants for a resource. When you `run` a model, `seed` data, or `snapshot` a dataset, dbt will run `grant` and/or `revoke` statements to ensure that the permissions on the database object match the `grants` you have configured on the resource.

Like all configurations, `grants` will be included in dbt project metadata, including [the manifest artifact](/reference/artifacts/manifest-json).

Expand Down
Binary file modified website/static/img/docs/dbt-cloud/Select-Groups-RBAC.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.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 189cbfa

Please sign in to comment.