Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example configuration of dbt_cloud.yml file #5970

Closed
1 task done
glsdown opened this issue Aug 23, 2024 · 0 comments · Fixed by #6124
Closed
1 task done

Update example configuration of dbt_cloud.yml file #5970

glsdown opened this issue Aug 23, 2024 · 0 comments · Fixed by #6124
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@glsdown
Copy link

glsdown commented Aug 23, 2024

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/docs/cloud/configure-cloud-cli

What part(s) of the page would you like to see updated?

The example config appears to be out of date:

version: "1"
context:
    active-project: "<project id from the list below>"
    active-host: "<active host from the list>"
    defer-env-id: "<optional defer environment id>"
projects:
- project-id: "<project-id>"
    account-host: "<account-host>"
    api-key: "<user-api-key>"

- project-id: "<project-id>"
    account-host: "<account-host>"
    api-key: "<user-api-key>"

When used, it gives the warning:

WARNING: User API Keys are being deprecated on September 18th, 2024 in favor of Personal Access Tokens - to upgrade, download your dbt_cloud.yml file again.

I believe the new structure should be:

version: "1"
context:
  active-project: "<project id from the list below>"
  active-host: "<active host from the list>"
  defer-env-id: "<optional defer environment id>"
projects:
  - project-name: "<project-name>"
    project-id: "<project-id>"
    account-name: "<account-name>"
    account-id: "<account-id>"
    account-host: "<account-host>" # e.g. "cloud.getdbt.com"
    token-name: "<pat-or-service-token-name>"
    token-value: "<pat-or-service-token-value>"

  - project-name: "<project-name>"
    project-id: "<project-id>"
    account-name: "<account-name>"
    account-id: "<account-id>"
    account-host: "<account-host>" # e.g. "cloud.getdbt.com"
    token-name: "<pat-or-service-token-name>"
    token-value: "<pat-or-service-token-value>"

Additional information

No response

@glsdown glsdown added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant