dbt-labs / docs.getdbt.com

The code behind docs.getdbt.com
https://docs.getdbt.com/
Apache License 2.0
113 stars 865 forks source link

Add MFA explainer #5721

Closed Fleid closed 3 days ago

Fleid commented 5 days ago

Following this conversation: https://dbt-labs.slack.com/archives/C02SRNY2EQ4/p1719421396340509

vercel[bot] commented 5 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com 🛑 Canceled (Inspect) Jul 4, 2024 8:47am
mirnawong1 commented 4 days ago

hey @Fleid , this looks awesome, thank you so much for doing this! I'm wondering if this content is better suited under the 'Authentication' header so it correctly represents the other way to authenticate? what do you think? i can see it's also a config thing too, but it's also an auth method and consistent with the dbt core set up doc too. e.g.:

## Authentication methods

...other auth methods...

### Snowflake MFA

**Available in:** Development environments,  Deployment environments

dbt Cloud supports Snowflake's [multi-factor authentication (MFA)](https://docs.snowflake.com/en/user-guide/security-mfa) for increased login security. Snowflake's MFA support is powered by the Duo Security service.

- In dbt Cloud, set the following [extended attribute](/docs/dbt-cloud-environments#extended-attributes) in the development environment **General settings** page, under the **Extended attributes** section:

  authenticator: username_password_mfa

- To reduce the number of user prompts when connecting to Snowflake with MFA, [enable token caching](https://docs.snowflake.com/en/user-guide/security-mfa#using-mfa-token-caching-to-minimize-the-number-of-prompts-during-authentication-optional) in Snowflake.
- Optionally, if users miss prompts and their Snowflake accounts get locked, you can prevent automatic retries by adding the following in the same **Extended attributes** section:

  connect_retries: 0

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/extended-attributes-mfa.jpg" width="70%" title="Configure the MFA username and password, and connect_retries in the development environment settings." />
Fleid commented 4 days ago

@mirnawong1 good catch!

I would not add an entire section, to me it's mostly redundant. MFA is an option of username/password. So I would move the paragraph from the bottom section to under username password. I can do it if you want ;)

mirnawong1 commented 4 days ago

oh ok i see! happy to do that for you @Fleid ! no worries 🙏

mirnawong1 commented 4 days ago

hey @Fleid , thanks for your feedback! i've updated it based on your feedback and placed it under 'auth' with a note about the snowflake mfa being part of the username/password flow! does this look right to you: https://docs-getdbt-ghrozntxd-dbt-labs.vercel.app/docs/cloud/connect-data-platform/connect-snowflake#snowflake-mfa

Screenshot 2024-07-03 at 18 09 47

mirnawong1 commented 3 days ago

thanks team, let's ship this awesome doc!