From 865611ab103a6965a06217c68ba63f5d2e5d5717 Mon Sep 17 00:00:00 2001 From: fmercadop Date: Wed, 28 Oct 2026 10:57:29 -0500 Subject: [PATCH 1/2] Update account prerequisites for the guided setup call --- docs/getting-started/create-account.md | 73 ++++++++++++++++++-------- 1 file changed, 51 insertions(+), 22 deletions(-) diff --git a/docs/getting-started/create-account.md b/docs/getting-started/create-account.md index 3702f16..7d0c8a0 100644 --- a/docs/getting-started/create-account.md +++ b/docs/getting-started/create-account.md @@ -6,15 +6,13 @@ sidebar_position: 1 --- # Configure your account with Datacoves +Your Datacoves account is configured during a setup call with the Datacoves team, who will guide you through the account setup wizard step by step. The wizard tests your data warehouse and git connections live, and will not let you continue until they succeed, so having the access and permissions below in place **before** the call is what keeps it short. + :::caution -The appropriate git repo access is required to be able to add deployment keys. -Be sure that you can add SSH keys to the repo or setup will not be able to finish. +A common blocker is git repository permissions. You need to be able to add a deploy key to the repository (see [Git](#git)). If you can't, make sure the person who can is available during the call. ::: -## Prerequisites - -Before the setup call with the Datacoves team, ensure you have the following ready. - +## Before the Call :::note Email gomezn@datacoves.com with the answers to the following two questions so we can be ready for the call. @@ -23,33 +21,64 @@ Email gomezn@datacoves.com with the answers to the following two questions so we 1. What version of dbt are you using? 2. Do you use Google / Google Workspace or Microsoft to authenticate? Datacoves leverages your existing authentication service. +## Who Should Join the Call + +- The person who will administer the Datacoves account. +- Someone with admin access to the git repository, if that's not you. +- Someone who can create users and grant privileges in your data warehouse, if that's not you. + +## Prerequisites + ### Data Warehouse -To set up your Datacoves account, you will need to know your data warehouse provider and have relevant access details handy. This includes the service account that Airflow will use. +To set up your Datacoves account, you will need to know your data warehouse provider and have relevant access details handy. This includes the service account that Airflow will use. | Data Warehouse Provider | Information Needed | | --- | --- | -| Snowflake | Account, Warehouse, Database, Role, User, Password, Schema | -| Redshift | Host, Database, User, Schema, Password | -| Databricks | Host, Schema, HTTP Path, Token | +| Snowflake | Account, Warehouse, Database, Role, Schema, User, Password | +| Redshift | Host, Database, Schema, User, Password | +| Databricks | Host, HTTP Path, Schema, Catalog (optional), Token | | BigQuery | Dataset, Keyfile JSON | +Your user needs to be able to use the warehouse and database, and to create objects in your development schema. The Airflow service account needs the same access to the schemas used for production runs. + :::warning -For the Snowflake `Account` field you will need to find your account locator and replace `.` with `-`. -Check out [Snowflake Fields](/docs/how-tos/datacoves/how_to_connection_template#for-snowflake-the-available-fields-are) on how to find your Snowflake account locator. +For the Snowflake `Account` field, use the `orgname-accountname` format (e.g. `myorg-myaccount`). This is the subdomain of your Snowflake URL. Do not include `snowflakecomputing.com`. Legacy account locators are also accepted. +Check out the Snowflake documentation on [finding the organization and account name for an account](https://docs.snowflake.com/en/user-guide/admin-account-identifier#finding-the-organization-and-account-name-for-an-account). ::: -**Network Access:** Verify that your Data Warehouse is accessible from outside your network. You'll need to whitelist the Datacoves IP - `74.179.200.137` +**Snowflake authentication:** The setup wizard only supports username and password authentication. Make sure your Snowflake user can log in with a password. The Airflow service account can also use key-pair authentication. +- Your personal Snowflake user needs MFA (e.g. Duo) enabled. This does not apply to the Airflow service account. Have your phone handy, since you'll need to approve the push notification when the connection is tested. +- We recommend that your Snowflake administrator enables [MFA token caching](https://docs.snowflake.com/en/user-guide/security-mfa#using-mfa-token-caching-to-minimize-the-number-of-prompts-during-authentication-optional) to avoid an MFA prompt on every connection. + +**Network Access:** Verify that your Data Warehouse is accessible from outside your network. You'll need to whitelist the Datacoves IP: `74.179.200.137`. ### Git -To configure the git integration, you will need: +Datacoves works with any git provider that supports SSH, such as GitHub, GitLab, Bitbucket, and Azure DevOps. During the wizard, Datacoves generates two SSH keys, and both are tested before you can continue: + +**Deploy Key** +Added to the repository and used by Datacoves services. You need the right role in your git provider to add it: + +| Git Provider | Where the key goes | Role required | +| --- | --- | --- | +| GitHub | Repository Settings > Deploy keys | Repository admin | +| GitLab | Project Settings > Repository > Deploy keys | Maintainer or higher | +| Bitbucket Cloud | Repository settings > Access keys | Repository admin | + +:::note[Azure DevOps] +Azure DevOps does not support repository deploy keys; SSH keys are added to a user profile (User settings > SSH public keys). During the wizard, add the deploy key to the profile of a user with access to the repository, and select `RSA (Azure Compatibility)` as the SSH key type, since Azure DevOps only supports RSA keys. Make sure SSH authentication is enabled in your organization's policies. + +After the wizard, the project can be switched to authenticate with an Entra ID application. See [How to Clone with Azure DevOps](/docs/how-tos/datacoves/how_to_projects/how_to_configure_azure_devops) for the prerequisites. +::: + +**Developer Key** +Added to **your own user account** in your git provider. Your user needs to be able to clone and push to the repository. If your organization enforces SSO (e.g. on GitHub), you may need to authorize the key for your organization. -**Git Access** -Ensure your user has access to add a deployment key to the repo, as well as access to clone and push changes. +See [How to configure an SSH Key](/docs/how-tos/git/ssh-keys) for details. -**Git Repo** -If this will be a new dbt project, create a new repo and ensure at least one file is in the `main` branch such as a `README.md`. Have your git clone URL handy. +**Git Repo** +Have the repository's **SSH** clone URL handy (e.g. `git@github.com:organization/repo.git`). If this will be a new dbt project, create a new repo and ensure at least one file is in the `main` branch such as a `README.md`. **dbt Docs** Create a `dbt-docs` branch in your repo. @@ -58,7 +87,7 @@ Create a `dbt-docs` branch in your repo. To ensure a smooth call, please have the answers to the following questions ready to go. -- What do you want to call your account? (This is usually the company name) -- What do you want to call your project? (This can be something like Marketing DW, Finance 360, etc) -- Do you currently have a CI/CD process and associated script like GitHub Actions workflow? If not, do you plan on creating a CI/CD process? -- Do you need any specific Python library on Airflow or VS Code? (outside the standard dbt-related items) +- What do you want to call your account? (This is usually the company name.) +- What do you want to call your project? (This can be something like Marketing DW, Finance 360, etc.) +- Do you currently have a CI/CD process and an associated script, such as a GitHub Actions workflow? If not, do you plan on creating a CI/CD process? +- Do you need any specific Python libraries in Airflow or VS Code, outside the standard dbt-related items? From 675718281ec65e67e9ab4aa0390b3784d63c6dd1 Mon Sep 17 00:00:00 2001 From: Noel Gomez Date: Tue, 3 Nov 2026 08:55:46 -0800 Subject: [PATCH 2/2] Revise account setup instructions for clarity Simplified the explanation of the account setup process. --- docs/getting-started/create-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/create-account.md b/docs/getting-started/create-account.md index 7d0c8a0..f258fbe 100644 --- a/docs/getting-started/create-account.md +++ b/docs/getting-started/create-account.md @@ -6,7 +6,7 @@ sidebar_position: 1 --- # Configure your account with Datacoves -Your Datacoves account is configured during a setup call with the Datacoves team, who will guide you through the account setup wizard step by step. The wizard tests your data warehouse and git connections live, and will not let you continue until they succeed, so having the access and permissions below in place **before** the call is what keeps it short. +Your Datacoves account is configured during a setup call with the Datacoves team. We will guide you through the account setup wizard step by step. The wizard tests your data warehouse and git connections live, and will not let you continue until they succeed, so having the access and permissions below in place **before** the call is what keeps it short. :::caution A common blocker is git repository permissions. You need to be able to add a deploy key to the repository (see [Git](#git)). If you can't, make sure the person who can is available during the call.