🤓 Who can do this? You will probably need your dbt Cloud administrator to complete these steps — you may not have access yourself.
If you have a dbt Cloud account, Atlan can help enrich your assets with dbt metadata.
🚨 Careful! To enable Atlan to fetch metadata for dbt models defined in your project, you must add the
dbt docs generate command to the list of commands in the job run steps. This will produce a catalog.json file containing all the relevant metadata. Alternatively, you can select the Generate docs on run checkbox to automatically generate updated project docs each time a job runs. Refer to dbt documentation to learn more.Create a token
Be sure to copy the generated token for crawling dbt.
Service account token
Only dbt Cloud administrators can generate service account tokens. This is required for authenticating as a service account user and to set up granular access permissions.
To generate a service account token, follow the steps in dbt documentation and configure the following permissions:
- Team plans: add Read-only access to all projects you want to integrate into Atlan. This permission is required to authorize requests to both the dbt Cloud Administrative API and dbt Cloud Discovery API.
- Enterprise plans: add Job Viewer access to all projects you want to integrate into Atlan. This will provide read-only access to your dbt account, project, environment, job, and run metadata. Learn more about dbt Cloud Enterprise permissions.
Personal access token
🚨 Careful! User API tokens will be deprecated and replaced with account-scoped personal access tokens by October 22, 2024. If you have configured any dbt crawler workflows in Atlan with user API tokens, you may encounter errors. You must modify the configuration for any existing workflows with updated credentials — either a service account or personal access token.
You can also create an account-scoped personal access token for crawling dbt.
To generate a personal access token, follow the steps in dbt documentation and note the following:
- The user creating the token must have Job Viewer access to all projects you want to integrate into Atlan. This will provide read-only access to your dbt account, project, environment, job, and run metadata.