Update doc and use global connection

Author: b-per

examples/dbtcloud_github_snowflake/main.tf

@@ -14,7 +14,7 @@ terraform {
     }
     dbtcloud = {
       source  = "dbt-labs/dbtcloud"
-      version = ">= 0.2.10"
+      version = ">= 0.3.0"
     }
   }
 }

modules/combined/dbtcloud_github_snowflake/README.md

@@ -4,7 +4,7 @@
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
-| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.2.10 |
+| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.3.0 |
 | <a name="requirement_github"></a> [github](#requirement\_github) | ~> 5.0 |
 | <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.71 |
 

modules/combined/dbtcloud_github_snowflake/main.tf

@@ -13,7 +13,7 @@ terraform {
     }
     dbtcloud = {
       source  = "dbt-labs/dbtcloud"
-      version = ">= 0.2.10"
+      version = ">= 0.3.0"
     }
   }
 }

modules/dbtcloud/dbtcloud_common/README.md

@@ -4,13 +4,13 @@
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
-| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.2.10 |
+| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.2.10 |
+| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.3.0 |
 
 ## Modules
 
@@ -26,21 +26,20 @@ No modules.
 | [dbtcloud_job.ci](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job) | resource |
 | [dbtcloud_job.daily_prod](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job) | resource |
 | [dbtcloud_project.dbt_project](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project) | resource |
-| [dbtcloud_project_connection.dbt_project_connection](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project_connection) | resource |
 | [dbtcloud_project_repository.dbt_project_repository](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project_repository) | resource |
 | [dbtcloud_repository.dbt_repository](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/repository) | resource |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_database_envs"></a> [database\_envs](#input\_database\_envs) | n/a | <pre>map(object({<br>    wh_size           = string<br>    defer_to_env_name = string<br>    git_branch        = string<br>  }))</pre> | n/a | yes |
+| <a name="input_database_envs"></a> [database\_envs](#input\_database\_envs) | The different environments required (i.e. DEV, PROD etc...) and their properties | <pre>map(object({<br>    wh_size           = string<br>    defer_to_env_name = string<br>    git_branch        = string<br>  }))</pre> | n/a | yes |
 | <a name="input_dbt_connection"></a> [dbt\_connection](#input\_dbt\_connection) | The connection to the DW | `map(any)` | n/a | yes |
-| <a name="input_dbt_creds"></a> [dbt\_creds](#input\_dbt\_creds) | n/a | `map(any)` | n/a | yes |
-| <a name="input_dbt_creds_ci"></a> [dbt\_creds\_ci](#input\_dbt\_creds\_ci) | n/a | `map(any)` | n/a | yes |
+| <a name="input_dbt_creds"></a> [dbt\_creds](#input\_dbt\_creds) | A map of environment name to dbt cloud credential ID | <pre>map(object({<br>    credential_id = integer<br>  }))</pre> | n/a | yes |
+| <a name="input_dbt_creds_ci"></a> [dbt\_creds\_ci](#input\_dbt\_creds\_ci) | A map of environment name to dbt cloud credential ID for CI | <pre>map(object({<br>    credential_id = integer<br>  }))</pre> | n/a | yes |
 | <a name="input_dbt_project_name"></a> [dbt\_project\_name](#input\_dbt\_project\_name) | The project name in dbt Cloud | `string` | n/a | yes |
 | <a name="input_dbt_version"></a> [dbt\_version](#input\_dbt\_version) | The dbt version | `string` | n/a | yes |
-| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | n/a | `map(any)` | n/a | yes |
+| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | Map of all the environments that can defer to another one in CI. Key and Value are the environment names | <pre>map(object({<br>    defer_to_env_name = string<br>  }))</pre> | n/a | yes |
 | <a name="input_github_installation_id"></a> [github\_installation\_id](#input\_github\_installation\_id) | The project name in dbt Cloud | `string` | n/a | yes |
 | <a name="input_github_repo_remote_url"></a> [github\_repo\_remote\_url](#input\_github\_repo\_remote\_url) | The remote URL for the GitHub repository | `string` | `null` | no |
 

modules/dbtcloud/dbtcloud_common/main.tf

@@ -4,7 +4,7 @@ terraform {
   required_providers {
     dbtcloud = {
       source  = "dbt-labs/dbtcloud"
-      version = ">= 0.2.10"
+      version = ">= 0.3.0"
     }
   }
 }
@@ -14,11 +14,6 @@ resource "dbtcloud_project" "dbt_project" {
   name = var.dbt_project_name
 }
 
-resource "dbtcloud_project_connection" "dbt_project_connection" {
-  project_id    = dbtcloud_project.dbt_project.id
-  connection_id = var.dbt_connection.connection_id
-}
-
 resource "dbtcloud_repository" "dbt_repository" {
   project_id             = dbtcloud_project.dbt_project.id
   remote_url             = var.github_repo_remote_url
@@ -40,6 +35,7 @@ resource "dbtcloud_environment" "envs" {
   type          = each.key == "DEV" ? "development"  : "deployment"
   deployment_type = each.key == "PROD" ? "production"  : null
   credential_id = each.key == "DEV" ? null : var.dbt_creds[each.key].credential_id
+  connection_id = var.dbt_connection.connection_id
   custom_branch = each.value["git_branch"]
   use_custom_branch = each.value["git_branch"] == null ? false : true
 }
@@ -51,6 +47,7 @@ resource "dbtcloud_environment" "envs_ci" {
   project_id    = dbtcloud_project.dbt_project.id
   type          = "deployment"
   credential_id = var.dbt_creds_ci[each.key].credential_id
+  connection_id = var.dbt_connection.connection_id
   custom_branch = var.database_envs[each.value["defer_to_env_name"]].git_branch
   use_custom_branch = var.database_envs[each.value["defer_to_env_name"]].git_branch == null ? false : true
 }

modules/dbtcloud/dbtcloud_common/variables.tf

@@ -27,6 +27,7 @@ variable "dbt_version" {
 }
 
 variable "database_envs" {
+  description = "The different environments required (i.e. DEV, PROD etc...) and their properties"
   type = map(object({
     wh_size           = string
     defer_to_env_name = string
@@ -35,13 +36,22 @@ variable "database_envs" {
 }
 
 variable "dbt_creds" {
-  type = map(any)
+  description = "A map of environment name to dbt cloud credential ID"
+  type = map(object({
+    credential_id = integer
+  }))
 }
 
 variable "dbt_creds_ci" {
-  type = map(any)
+  description = "A map of environment name to dbt cloud credential ID for CI"
+  type = map(object({
+    credential_id = integer
+  }))
 }
 
 variable "defer_from_to" {
-  type = map(any)
+  description = "Map of all the environments that can defer to another one in CI. Key and Value are the environment names"
+  type = map(object({
+    defer_to_env_name = string
+  }))
 }

modules/dbtcloud/dbtcloud_snowflake/README.md

@@ -4,13 +4,13 @@
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
-| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.2.10 |
+| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.2.10 |
+| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.3.0 |
 
 ## Modules
 
@@ -20,7 +20,7 @@ No modules.
 
 | Name | Type |
 |------|------|
-| [dbtcloud_connection.dbt_connection](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/connection) | resource |
+| [dbtcloud_global_connection.dbt_connection](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/global_connection) | resource |
 | [dbtcloud_snowflake_credential.creds](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/snowflake_credential) | resource |
 | [dbtcloud_snowflake_credential.creds_ci](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/snowflake_credential) | resource |
 
@@ -30,8 +30,8 @@ No modules.
 |------|-------------|------|---------|:--------:|
 | <a name="input_dbt_project_id"></a> [dbt\_project\_id](#input\_dbt\_project\_id) | The Project ID for the dbt Cloud Project | `number` | n/a | yes |
 | <a name="input_dbt_project_name"></a> [dbt\_project\_name](#input\_dbt\_project\_name) | The Project ID for the dbt Cloud Project | `string` | n/a | yes |
-| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | n/a | `map(any)` | n/a | yes |
-| <a name="input_envs_except_dev"></a> [envs\_except\_dev](#input\_envs\_except\_dev) | n/a | `map(any)` | n/a | yes |
+| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | Map of all the environments that can defer to another one in CI. Key and Value are the environment names | <pre>map(object({<br>    defer_to_env_name = string<br>  }))</pre> | n/a | yes |
+| <a name="input_envs_except_dev"></a> [envs\_except\_dev](#input\_envs\_except\_dev) | The deployment environments. A subset of `database_envs`. | `map(any)` | n/a | yes |
 | <a name="input_snowflake_account"></a> [snowflake\_account](#input\_snowflake\_account) | The Snowflake Account ID | `string` | n/a | yes |
 | <a name="input_snowflake_databases"></a> [snowflake\_databases](#input\_snowflake\_databases) | The Snowflake Databases that were created | <pre>map(object({<br>      name = string<br>    }))</pre> | n/a | yes |
 | <a name="input_snowflake_roles"></a> [snowflake\_roles](#input\_snowflake\_roles) | The Snowflake Roles that were created | <pre>map(object({<br>      name = string<br>    }))</pre> | n/a | yes |

modules/dbtcloud/dbtcloud_snowflake/main.tf

@@ -5,21 +5,22 @@ terraform {
   required_providers {
     dbtcloud = {
       source  = "dbt-labs/dbtcloud"
-      version = ">= 0.2.10"
+      version = ">= 0.3.0"
     }
   }
 }
 
-// create a connection and link the project to the connection
+
+// create a global connection that we will link to environments
 // this is an example with Snowflake but for other warehouses please look at the resource docs
-resource "dbtcloud_connection" "dbt_connection" {
-  project_id = var.dbt_project_id
-  type       = "snowflake"
-  name       = "WH ${var.dbt_project_name}"
-  account    = var.snowflake_account
-  database   = var.snowflake_databases["DEV"].name
-  role       = var.snowflake_roles["DEV"].name
-  warehouse  = var.snowflake_warehouses["DEV"].name
+resource "dbtcloud_global_connection" "dbt_connection" {
+  name = "Snowflake DW - ${var.dbt_project_name}"
+  snowflake = {
+    account                   = var.snowflake_account
+    database                  = var.snowflake_databases["DEV"].name
+    warehouse                 = var.snowflake_warehouses["DEV"].name
+    role                      = var.snowflake_roles["DEV"].name
+  }
 }
 
 // we use user/password but there are other options on the resource docs

modules/dbtcloud/dbtcloud_snowflake/outputs.tf

@@ -1,5 +1,5 @@
 output "dbt_connection" {
-  value = dbtcloud_connection.dbt_connection
+  value = dbtcloud_global_connection.dbt_connection
 }
 
 output "dbt_creds" {

modules/dbtcloud/dbtcloud_snowflake/variables.tf

@@ -43,9 +43,13 @@ variable "snowflake_service_users" {
 }
 
 variable "envs_except_dev" {
+  description = "The deployment environments. A subset of `database_envs`."
   type = map(any)
 }
 
 variable "defer_from_to" {
-  type = map(any)
+  description = "Map of all the environments that can defer to another one in CI. Key and Value are the environment names"
+  type = map(object({
+    defer_to_env_name = string
+  }))
 }