Merge pull request #196 from dbt-labs/release-0.2.9

Release 0.2.9

Author: b-per

CHANGELOG.md

@@ -2,7 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.8...HEAD)
+## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.9...HEAD)
+
+## [0.2.9](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.8...v0.2.9)
+
+## Changes
+
+- Add support for extended attributes for environments [(docs)](https://docs.getdbt.com/docs/dbt-cloud-environments#extended-attributes-beta), allowing people to add connection attributes available in dbt-core but not in the dbt Cloud interface
+- [#191](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/191) - Allow setting a description for jobs
 
 ## [0.2.8](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.7...v0.2.8)
 

docs/data-sources/environment.md

@@ -26,6 +26,7 @@ description: |-
 - `custom_branch` (String) Which custom branch to use in this environment
 - `dbt_version` (String) Version number of dbt to use in this environment, usually in the format 1.2.0-latest rather than core versions
 - `deployment_type` (String) The type of deployment environment (currently 'production' or empty)
+- `extended_attributes_id` (Number) The ID of the extended attributes applied
 - `id` (String) The ID of this resource.
 - `is_active` (Boolean) Whether the environment is active
 - `name` (String) Environment name

docs/data-sources/extended_attributes.md

@@ -0,0 +1,36 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "dbtcloud_extended_attributes Data Source - dbtcloud"
+subcategory: ""
+description: |-
+  
+---
+
+# dbtcloud_extended_attributes (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+data "dbtcloud_extended_attributes" "my_extended_attributes" {
+    extended_attributes_id = 12345
+    project_id             = 6789
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `extended_attributes_id` (Number) ID of the extended attributes
+- `project_id` (Number) Project ID the extended attributes refers to
+
+### Read-Only
+
+- `extended_attributes` (String) A JSON string listing the extended attributes mapping
+- `id` (String) The ID of this resource.
+- `state` (Number) The state of the extended attributes (1 = active, 2 = inactive)
+
+

docs/data-sources/job.md

@@ -24,6 +24,7 @@ description: |-
 
 - `deferring_environment_id` (Number) ID of the environment this job defers to
 - `deferring_job_id` (Number) ID of the job this job defers to
+- `description` (String) Long description for the job
 - `environment_id` (Number) ID of the environment the job is in
 - `id` (String) The ID of this resource.
 - `name` (String) Given name for the job

docs/resources/environment.md

@@ -51,6 +51,7 @@ resource "dbtcloud_environment" "prod_environment" {
 - `credential_id` (Number) Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
 - `custom_branch` (String) Which custom branch to use in this environment
 - `deployment_type` (String) The type of environment. Only valid for environments of type 'deployment' and for now can only be empty or set to 'production'
+- `extended_attributes_id` (Number) ID of the extended attributes for the environment
 - `is_active` (Boolean) Whether the environment is active
 - `use_custom_branch` (Boolean) Whether to use a custom git branch in this environment
 

docs/resources/extended_attributes.md

@@ -0,0 +1,69 @@
+---
+page_title: "dbtcloud_extended_attributes Resource - dbtcloud"
+subcategory: ""
+description: |-
+  This resource allows setting extended attributes which can be assigned to a given environment (see docs https://docs.getdbt.com/docs/dbt-cloud-environments#extended-attributes-beta).In dbt Cloud those values are provided as YML but in the provider they need to be provided as JSON (see example below).
+---
+
+# dbtcloud_extended_attributes (Resource)
+
+
+This resource allows setting extended attributes which can be assigned to a given environment ([see docs](https://docs.getdbt.com/docs/dbt-cloud-environments#extended-attributes-beta)).<br/><br/>In dbt Cloud those values are provided as YML but in the provider they need to be provided as JSON (see example below).
+
+## Example Usage
+
+```terraform
+# extended_attributes can be set as a raw JSON string or encoded with Terraform's `jsonencode()` function
+# we recommend using `jsonencode()` to avoid Terraform reporting changes due to whitespaces or keys ordering
+resource "dbtcloud_extended_attributes" "my_attributes" {
+  extended_attributes = jsonencode(
+    {
+      type      = "databricks"
+      catalog   = "dbt_catalog"
+      http_path = "/sql/your/http/path"
+      my_nested_field = {
+        subfield = "my_value"
+      }
+    }
+  )
+  project_id = var.dbt_project_id
+}
+
+resource dbtcloud_environment issue_depl {
+  dbt_version            = "1.6.0-latest"
+  name                   = "My environment"
+  project_id             = var.dbt_project_id
+  type                   = "deployment"
+  use_custom_branch      = false
+  credential_id          = var.dbt_credential_id
+  deployment_type        = "production"
+  extended_attributes_id = dbtcloud_extended_attributes.my_attributes.extended_attributes_id
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `extended_attributes` (String) A JSON string listing the extended attributes mapping. The keys are the connections attributes available in the `profiles.yml` for a given adapter. Any fields entered will override connection details or credentials set on the environment or project. To avoid incorrect Terraform diffs, it is recommended to create this string using `jsonencode` in your Terraform code. (see example)
+- `project_id` (Number) Project ID to create the extended attributes in
+
+### Optional
+
+- `state` (Number) Extended Attributes state (1 is active, 2 is inactive)
+
+### Read-Only
+
+- `extended_attributes_id` (Number) Extended Attributes ID
+- `id` (String) The ID of this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using a project ID and extended attribute ID found in the URL or via the API.
+terraform import dbtcloud_extended_attributes.test_extended_attributes "project_id_id:extended_attributes_id"
+terraform import dbtcloud_extended_attributes.test_extended_attributes 12345:6789
+```

docs/resources/job.md

@@ -59,6 +59,7 @@ resource "dbtcloud_job" "test" {
 - `dbt_version` (String) Version number of dbt to use in this job, usually in the format 1.2.0-latest rather than core versions
 - `deferring_environment_id` (Number) Environment identifier that this job defers to (new deferring approach)
 - `deferring_job_id` (Number) Job identifier that this job defers to (legacy deferring approach)
+- `description` (String) Description for the job
 - `generate_docs` (Boolean) Flag for whether the job should generate documentation
 - `is_active` (Boolean) Flag for whether the job is marked active or deleted
 - `num_threads` (Number) Number of threads to use in the job

examples/data-sources/dbtcloud_extended_attributes/data-source.tf

@@ -0,0 +1,4 @@
+data "dbtcloud_extended_attributes" "my_extended_attributes" {
+    extended_attributes_id = 12345
+    project_id             = 6789
+}

examples/resources/dbtcloud_extended_attributes/import.sh

@@ -0,0 +1,3 @@
+# Import using a project ID and extended attribute ID found in the URL or via the API.
+terraform import dbtcloud_extended_attributes.test_extended_attributes "project_id_id:extended_attributes_id"
+terraform import dbtcloud_extended_attributes.test_extended_attributes 12345:6789

examples/resources/dbtcloud_extended_attributes/resource.tf

@@ -0,0 +1,26 @@
+# extended_attributes can be set as a raw JSON string or encoded with Terraform's `jsonencode()` function
+# we recommend using `jsonencode()` to avoid Terraform reporting changes due to whitespaces or keys ordering
+resource "dbtcloud_extended_attributes" "my_attributes" {
+  extended_attributes = jsonencode(
+    {
+      type      = "databricks"
+      catalog   = "dbt_catalog"
+      http_path = "/sql/your/http/path"
+      my_nested_field = {
+        subfield = "my_value"
+      }
+    }
+  )
+  project_id = var.dbt_project_id
+}
+
+resource dbtcloud_environment issue_depl {
+  dbt_version            = "1.6.0-latest"
+  name                   = "My environment"
+  project_id             = var.dbt_project_id
+  type                   = "deployment"
+  use_custom_branch      = false
+  credential_id          = var.dbt_credential_id
+  deployment_type        = "production"
+  extended_attributes_id = dbtcloud_extended_attributes.my_attributes.extended_attributes_id
+}