Merge pull request #249 from dbt-labs/release-0.2.25

dbt-labs · Apr 18, 2024 · 0f0fe0b · 0f0fe0b
2 parents c128bd5 + 49997cd
commit 0f0fe0b
Show file tree

Hide file tree

Showing 6 changed files with 429 additions and 112 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.24...HEAD)
+## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.25...HEAD)
+
+## [0.2.25](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.24...v0.2.25)
+
+## Changes
+
+- Enable OAuth configuration for Databricks connections + update docs accordingly
 
 ## [0.2.24](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.23...v0.2.24)
 

diff --git a/docs/resources/connection.md b/docs/resources/connection.md
@@ -23,13 +23,16 @@ For BigQuery, due to the list of fields being very different, you can use the `d
 // legacy names will be removed from 0.3 onwards
 
 resource "dbtcloud_connection" "databricks" {
-  project_id = dbtcloud_project.dbt_project.id
-  type       = "adapter"
-  name       = "Databricks"
-  database   = "" // currenyly need to be empty for databricks
-  host_name  = "my-databricks-host.cloud.databricks.com"
-  http_path  = "/my/path"
-  catalog    = "moo"
+  project_id          = dbtcloud_project.dbt_project.id
+  type                = "adapter"
+  name                = "Databricks"
+  database            = "" // currenyly need to be empty for databricks
+  host_name           = "my-databricks-host.cloud.databricks.com"
+  http_path           = "/my/path"
+  catalog             = "moo"
+  // add the following for OAuth 
+  oauth_client_id     = "yourclientid"
+  oauth_client_secret = "yourclientsecret"
 }
 
 resource "dbtcloud_connection" "redshift" {
@@ -42,13 +45,17 @@ resource "dbtcloud_connection" "redshift" {
 }
 
 resource "dbtcloud_connection" "snowflake" {
-  project_id = dbtcloud_project.dbt_project.id
-  type       = "snowflake"
-  name       = "My Snowflake warehouse"
-  account    = "my-snowflake-account"
-  database   = "MY_DATABASE"
-  role       = "MY_ROLE"
-  warehouse  = "MY_WAREHOUSE"
+  project_id          = dbtcloud_project.dbt_project.id
+  type                = "snowflake"
+  name                = "My Snowflake warehouse"
+  account             = "my-snowflake-account"
+  database            = "MY_DATABASE"
+  role                = "MY_ROLE"
+  warehouse           = "MY_WAREHOUSE"
+  // add the following for OAuth 
+  oauth_client_id     = "yourclientid"
+  oauth_client_secret = "yourclientsecret"
+  allow_sso           = true
 }
 ```
 
@@ -64,24 +71,24 @@ resource "dbtcloud_connection" "snowflake" {
 
 ### Optional
 
-- `account` (String) Account name for the connection
-- `allow_keep_alive` (Boolean) Whether or not the connection should allow client session keep alive
-- `allow_sso` (Boolean) Whether or not the connection should allow SSO
-- `catalog` (String) Catalog name if Unity Catalog is enabled in your Databricks workspace
+- `account` (String) Account name for the connection (for Snowflake)
+- `allow_keep_alive` (Boolean) Whether or not the connection should allow client session keep alive (for Snowflake)
+- `allow_sso` (Boolean) Whether or not the connection should allow SSO (for Snowflake)
+- `catalog` (String) Catalog name if Unity Catalog is enabled in your Databricks workspace (for Databricks)
 - `host_name` (String) Host name for the connection, including Databricks cluster
-- `http_path` (String) The HTTP path of the Databricks cluster or SQL warehouse
+- `http_path` (String) The HTTP path of the Databricks cluster or SQL warehouse (for Databricks)
 - `is_active` (Boolean) Whether the connection is active
-- `oauth_client_id` (String) OAuth client identifier
-- `oauth_client_secret` (String) OAuth client secret
+- `oauth_client_id` (String) OAuth client identifier (for Snowflake and Databricks)
+- `oauth_client_secret` (String) OAuth client secret (for Snowflake and Databricks)
 - `port` (Number) Port number to connect via
 - `private_link_endpoint_id` (String) The ID of the PrivateLink connection. This ID can be found using the `privatelink_endpoint` data source
-- `role` (String) Role name for the connection
+- `role` (String) Role name for the connection (for Snowflake)
 - `tunnel_enabled` (Boolean) Whether or not tunneling should be enabled on your database connection
-- `warehouse` (String) Warehouse name for the connection
+- `warehouse` (String) Warehouse name for the connection (for Snowflake)
 
 ### Read-Only
 
-- `adapter_id` (Number) Adapter id created for the Databricks connection
+- `adapter_id` (Number) Adapter id created for the Databricks connection (for Databricks)
 - `connection_id` (Number) Connection Identifier
 - `id` (String) The ID of this resource.
 

diff --git a/examples/resources/dbtcloud_connection/resource.tf b/examples/resources/dbtcloud_connection/resource.tf
@@ -3,13 +3,16 @@
 // legacy names will be removed from 0.3 onwards
 
 resource "dbtcloud_connection" "databricks" {
-  project_id = dbtcloud_project.dbt_project.id
-  type       = "adapter"
-  name       = "Databricks"
-  database   = "" // currenyly need to be empty for databricks
-  host_name  = "my-databricks-host.cloud.databricks.com"
-  http_path  = "/my/path"
-  catalog    = "moo"
+  project_id          = dbtcloud_project.dbt_project.id
+  type                = "adapter"
+  name                = "Databricks"
+  database            = "" // currenyly need to be empty for databricks
+  host_name           = "my-databricks-host.cloud.databricks.com"
+  http_path           = "/my/path"
+  catalog             = "moo"
+  // add the following for OAuth 
+  oauth_client_id     = "yourclientid"
+  oauth_client_secret = "yourclientsecret"
 }
 
 resource "dbtcloud_connection" "redshift" {
@@ -22,11 +25,15 @@ resource "dbtcloud_connection" "redshift" {
 }
 
 resource "dbtcloud_connection" "snowflake" {
-  project_id = dbtcloud_project.dbt_project.id
-  type       = "snowflake"
-  name       = "My Snowflake warehouse"
-  account    = "my-snowflake-account"
-  database   = "MY_DATABASE"
-  role       = "MY_ROLE"
-  warehouse  = "MY_WAREHOUSE"
+  project_id          = dbtcloud_project.dbt_project.id
+  type                = "snowflake"
+  name                = "My Snowflake warehouse"
+  account             = "my-snowflake-account"
+  database            = "MY_DATABASE"
+  role                = "MY_ROLE"
+  warehouse           = "MY_WAREHOUSE"
+  // add the following for OAuth 
+  oauth_client_id     = "yourclientid"
+  oauth_client_secret = "yourclientsecret"
+  allow_sso           = true
 }
diff --git a/pkg/dbt_cloud/connection.go b/pkg/dbt_cloud/connection.go
@@ -122,6 +122,8 @@ func (c *Client) CreateConnection(
 			hostName,
 			httpPath,
 			catalog,
+			oAuthClientID,
+			oAuthClientSecret,
 		)
 	} else {
 		connectionDetails.Account = account
@@ -185,7 +187,8 @@ func (c *Client) CreateConnection(
 		return nil, err
 	}
 
-	if (oAuthClientID != "") && (oAuthClientSecret != "") {
+	// those are secrets and not given back by the API
+	if (oAuthClientID != "") && (oAuthClientSecret != "") && (connectionType != "adapter") {
 		connectionResponse.Data.Details.OAuthClientID = oAuthClientID
 		connectionResponse.Data.Details.OAuthClientSecret = oAuthClientSecret
 	}
@@ -277,6 +280,8 @@ func GetDatabricksConnectionDetails(
 	hostName string,
 	httpPath string,
 	catalog string,
+	clientID string,
+	clientSecret string,
 ) *AdapterCredentialDetails {
 	noValidation := AdapterCredentialFieldMetadataValidation{
 		Required: false,
@@ -321,11 +326,39 @@ func GetDatabricksConnectionDetails(
 		Value:    httpPath,
 	}
 
-	fieldOrder := []string{"type", "host", "http_path"}
+	clientIDMetadata := AdapterCredentialFieldMetadata{
+		Label:        "OAuth Client ID",
+		Description:  "Required to enable Databricks OAuth authentication for IDE developers.",
+		Field_Type:   "text",
+		Encrypt:      true,
+		Overrideable: false,
+		Validation:   noValidation,
+	}
+	clientIDField := AdapterCredentialField{
+		Metadata: clientIDMetadata,
+		Value:    clientID,
+	}
+
+	clientSecretMetadata := AdapterCredentialFieldMetadata{
+		Label:        "OAuth Client Secret",
+		Description:  "Required to enable Databricks OAuth authentication for IDE developers.",
+		Field_Type:   "text",
+		Encrypt:      true,
+		Overrideable: false,
+		Validation:   noValidation,
+	}
+	clientSecretField := AdapterCredentialField{
+		Metadata: clientSecretMetadata,
+		Value:    clientSecret,
+	}
+
+	fieldOrder := []string{"type", "host", "http_path", "client_id", "client_secret"}
 	fields := map[string]AdapterCredentialField{
-		"type":      typeField,
-		"host":      hostField,
-		"http_path": httpPathField,
+		"type":          typeField,
+		"host":          hostField,
+		"http_path":     httpPathField,
+		"client_id":     clientIDField,
+		"client_secret": clientSecretField,
 	}
 
 	if catalog != "" {