include fix for hashicorp#9785

* Current progress * Enable CMK working * Add validation for cmk * Add nil check for amlWorkspaceID * Attempt to fix complete test case * remove maxitems from storage_account_identity * Fix lint errors * Modify test TestAccDatabricksWorkspace_update * Remove the set for ui_definition_uri * Update test cases * Add test cases for new attributes * Fixing test again * Commenting out unused test code for now * Update azurerm/internal/services/databricks/databricks_workspace_resource.go Co-authored-by: kt <[email protected]> * Update azurerm/internal/services/databricks/databricks_workspace_resource.go Co-authored-by: kt <[email protected]> * Update azurerm/internal/services/databricks/databricks_workspace_resource.go Co-authored-by: kt <[email protected]> * Address PR comments... * Update validation checks * Fix lint error * Refactoring validation for readability * Refactor the world * Fixing my dyslexia in my uber comment... * Update tests * Bug fix * Moved managed CMK code * Remove computed from custom_parameters * Revert update to custom_parameters * Enable CMK tests * Middle of massive refactor to new resource * Moved to new resource * terrafmt documentation * Fix test case * Add new step to test case * Update import test * Update import test * Update importer setId * Additional test updates * Fix lint errors * Import fix * moved cmk out of custom params * terrafmt * Another terrafmt * Update tests to validate parent resource * Update CMK to always pass all custom params * Fixing my dyslexia again * Update delete to pass all params * Add dependency on CMK for access policy * Wait a minute... Strike that. Reverse it. * no_public_ip cannot be changed once set * Fix invalid update and infra tests * Fix test cleanup configurations * Fix update test as everything is force new * Trying unhook the associations so destroy works * Remove just the subnet delegation * Delete the NSG first the the delegation * Remove assoc order * Modify step one of cleanup * Disable no public ip in clean up * remove deprecated attributes from tests * Documentation update only... * Remove the local specific URL from the docs... * Address PR comments * Force databricks deletion first * Remove fix for broken tests * add workspace dependency on nsg * Strike that, reverse it... * Not the NSG the NSGA Co-authored-by: kt <[email protected]>
yupwei68 · Jul 26, 2021 · ffb6bc7 · ffb6bc7
1 parent f79eca8
commit ffb6bc7
Show file tree

Hide file tree

Showing 12 changed files with 1,414 additions and 75 deletions.
diff --git a/azurerm/internal/services/databricks/databricks_customer_managed_key_resource.go b/azurerm/internal/services/databricks/databricks_customer_managed_key_resource.go
@@ -0,0 +1,309 @@
+package databricks
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"strings"
+	"time"
+
+	"github.com/Azure/azure-sdk-for-go/services/databricks/mgmt/2018-04-01/databricks"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/tf"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/clients"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/locks"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/databricks/parse"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/databricks/validate"
+	keyVaultParse "github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/keyvault/parse"
+	keyVaultValidate "github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/keyvault/validate"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/tf/pluginsdk"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/timeouts"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/utils"
+)
+
+func resourceDatabricksWorkspaceCustomerManagedKey() *pluginsdk.Resource {
+	return &pluginsdk.Resource{
+		Create: DatabricksWorkspaceCustomerManagedKeyCreateUpdate,
+		Read:   DatabricksWorkspaceCustomerManagedKeyRead,
+		Update: DatabricksWorkspaceCustomerManagedKeyCreateUpdate,
+		Delete: DatabricksWorkspaceCustomerManagedKeyDelete,
+
+		Timeouts: &pluginsdk.ResourceTimeout{
+			Create: pluginsdk.DefaultTimeout(30 * time.Minute),
+			Read:   pluginsdk.DefaultTimeout(5 * time.Minute),
+			Update: pluginsdk.DefaultTimeout(30 * time.Minute),
+			Delete: pluginsdk.DefaultTimeout(30 * time.Minute),
+		},
+
+		Importer: pluginsdk.ImporterValidatingResourceIdThen(func(id string) error {
+			_, err := parse.CustomerManagedKeyID(id)
+			return err
+		}, func(ctx context.Context, d *pluginsdk.ResourceData, meta interface{}) ([]*pluginsdk.ResourceData, error) {
+			client := meta.(*clients.Client).DataBricks.WorkspacesClient
+
+			// validate that the passed ID is a valid CMK configuration ID
+			customManagedKey, err := parse.CustomerManagedKeyID(d.Id())
+			if err != nil {
+				return []*pluginsdk.ResourceData{d}, fmt.Errorf("parsing Databricks workspace customer managed key ID %q for import: %v", d.Id(), err)
+			}
+
+			// convert the passed custom Managed Key ID to a valid workspace ID
+			workspace := parse.NewWorkspaceID(customManagedKey.SubscriptionId, customManagedKey.ResourceGroup, customManagedKey.CustomerMangagedKeyName)
+
+			// validate that the workspace exists
+			if _, err = client.Get(ctx, workspace.ResourceGroup, workspace.Name); err != nil {
+				return []*pluginsdk.ResourceData{d}, fmt.Errorf("retrieving the Databricks workspace customer managed key configuration(ID: %q) for workspace (ID: %q): %s", customManagedKey.ID(), workspace.ID(), err)
+			}
+
+			// set the new values for the CMK resource
+			d.SetId(customManagedKey.ID())
+			d.Set("workspace_id", workspace.ID())
+
+			return []*pluginsdk.ResourceData{d}, nil
+		}),
+
+		Schema: map[string]*pluginsdk.Schema{
+			"workspace_id": {
+				Type:         pluginsdk.TypeString,
+				Required:     true,
+				ValidateFunc: validate.WorkspaceID,
+			},
+
+			// Make this key vault key id and abstract everything from the string...
+			"key_vault_key_id": {
+				Type:         pluginsdk.TypeString,
+				Required:     true,
+				ValidateFunc: keyVaultValidate.KeyVaultChildID,
+			},
+		},
+	}
+}
+
+func DatabricksWorkspaceCustomerManagedKeyCreateUpdate(d *pluginsdk.ResourceData, meta interface{}) error {
+	workspaceClient := meta.(*clients.Client).DataBricks.WorkspacesClient
+	keyVaultsClient := meta.(*clients.Client).KeyVault
+	subscriptionId := meta.(*clients.Client).Account.SubscriptionId
+	ctx, cancel := timeouts.ForCreateUpdate(meta.(*clients.Client).StopContext, d)
+	defer cancel()
+
+	workspaceIDRaw := d.Get("workspace_id").(string)
+	workspaceID, err := parse.WorkspaceID(workspaceIDRaw)
+	if err != nil {
+		return err
+	}
+
+	keyIdRaw := d.Get("key_vault_key_id").(string)
+	key, err := keyVaultParse.ParseNestedItemID(keyIdRaw)
+	if err != nil {
+		return err
+	}
+
+	// Not sure if I should also lock the key vault here too
+	// or at the very least the key?
+	locks.ByName(workspaceID.Name, "azurerm_databricks_workspace")
+	defer locks.UnlockByName(workspaceID.Name, "azurerm_databricks_workspace")
+	var encryptionEnabled, infrastructureEnabled bool
+
+	workspace, err := workspaceClient.Get(ctx, workspaceID.ResourceGroup, workspaceID.Name)
+	if err != nil {
+		return fmt.Errorf("retrieving Databricks Workspace %q (Resource Group %q): %+v", workspaceID.Name, workspaceID.ResourceGroup, err)
+	}
+	if workspace.Parameters != nil {
+		if workspace.Parameters.RequireInfrastructureEncryption != nil {
+			infrastructureEnabled = *workspace.Parameters.RequireInfrastructureEncryption.Value
+		}
+		if workspace.Parameters.PrepareEncryption != nil {
+			encryptionEnabled = *workspace.Parameters.PrepareEncryption.Value
+		}
+	} else {
+		return fmt.Errorf("retrieving Databricks Workspace %q (Resource Group %q): `WorkspaceCustomParameters` was nil", workspaceID.Name, workspaceID.ResourceGroup)
+	}
+
+	if infrastructureEnabled {
+		return fmt.Errorf("Databricks Workspace %q (Resource Group %q): `infrastructure_encryption_enabled` must be set to `false`", workspaceID.Name, workspaceID.ResourceGroup)
+	}
+	if !encryptionEnabled {
+		return fmt.Errorf("Databricks Workspace %q (Resource Group %q): `customer_managed_key_enabled` must be set to `true`", workspaceID.Name, workspaceID.ResourceGroup)
+	}
+
+	// make sure the key vault exists
+	keyVaultIdRaw, err := keyVaultsClient.KeyVaultIDFromBaseUrl(ctx, meta.(*clients.Client).Resource, key.KeyVaultBaseUrl)
+	if err != nil || keyVaultIdRaw == nil {
+		return fmt.Errorf("retrieving the Resource ID for the Key Vault at URL %q: %+v", key.KeyVaultBaseUrl, err)
+	}
+
+	resourceID := parse.NewCustomerManagedKeyID(subscriptionId, workspaceID.ResourceGroup, workspaceID.Name)
+
+	if d.IsNewResource() {
+		if workspace.Parameters.Encryption != nil {
+			return tf.ImportAsExistsError("azurerm_databricks_workspace_customer_managed_key", resourceID.ID())
+		}
+	}
+
+	// We need to pull all of the custom params from the parent
+	// workspace resource and then add our new encryption values into the
+	// structure, else the other values set in the parent workspace
+	// resource will be lost and overwritten as nil. ¯\_(ツ)_/¯
+	// NOTE: 'workspace.Parameters' will never be nil as 'customer_managed_key_enabled' and 'infrastructure_encryption_enabled'
+	// fields have a default value in the parent workspace resource.
+	params := workspace.Parameters
+	params.Encryption = &databricks.WorkspaceEncryptionParameter{
+		Value: &databricks.Encryption{
+			KeySource:   databricks.MicrosoftKeyvault,
+			KeyName:     &key.Name,
+			KeyVersion:  &key.Version,
+			KeyVaultURI: &key.KeyVaultBaseUrl,
+		},
+	}
+
+	props := databricks.Workspace{
+		Location: workspace.Location,
+		Sku:      workspace.Sku,
+		WorkspaceProperties: &databricks.WorkspaceProperties{
+			ManagedResourceGroupID: workspace.WorkspaceProperties.ManagedResourceGroupID,
+			Parameters:             params,
+		},
+		Tags: workspace.Tags,
+	}
+
+	future, err := workspaceClient.CreateOrUpdate(ctx, props, resourceID.ResourceGroup, resourceID.CustomerMangagedKeyName)
+	if err != nil {
+		return fmt.Errorf("creating/updating %s: %+v", resourceID, err)
+	}
+
+	if err = future.WaitForCompletionRef(ctx, workspaceClient.Client); err != nil {
+		return fmt.Errorf("waiting for create/update of %s: %+v", resourceID, err)
+	}
+
+	d.SetId(resourceID.ID())
+	return DatabricksWorkspaceCustomerManagedKeyRead(d, meta)
+}
+
+func DatabricksWorkspaceCustomerManagedKeyRead(d *pluginsdk.ResourceData, meta interface{}) error {
+	client := meta.(*clients.Client).DataBricks.WorkspacesClient
+	ctx, cancel := timeouts.ForRead(meta.(*clients.Client).StopContext, d)
+	defer cancel()
+
+	id, err := parse.CustomerManagedKeyID(d.Id())
+	if err != nil {
+		return err
+	}
+
+	workspaceId := parse.NewWorkspaceID(id.SubscriptionId, id.ResourceGroup, id.CustomerMangagedKeyName)
+
+	resp, err := client.Get(ctx, id.ResourceGroup, id.CustomerMangagedKeyName)
+	if err != nil {
+		if utils.ResponseWasNotFound(resp.Response) {
+			log.Printf("[DEBUG] %s was not found - removing from state", *id)
+			d.SetId("")
+			return nil
+		}
+
+		return fmt.Errorf("retrieving %s: %+v", *id, err)
+	}
+
+	keySource := ""
+	keyName := ""
+	keyVersion := ""
+	keyVaultURI := ""
+
+	if resp.WorkspaceProperties.Parameters != nil {
+		if props := resp.WorkspaceProperties.Parameters.Encryption; props != nil {
+			if props.Value.KeySource != "" {
+				keySource = string(props.Value.KeySource)
+			}
+			if props.Value.KeyName != nil {
+				keyName = *props.Value.KeyName
+			}
+			if props.Value.KeyVersion != nil {
+				keyVersion = *props.Value.KeyVersion
+			}
+			if props.Value.KeyVaultURI != nil {
+				keyVaultURI = *props.Value.KeyVaultURI
+			}
+		}
+	}
+
+	// I have to get rid of this check due to import if you want to re-cmk your DBFS.
+	// This is because when you delete this it sets the key source to default
+	// if !strings.EqualFold(keySource, string(databricks.MicrosoftKeyvault)) {
+	// 	return fmt.Errorf("retrieving Databricks Workspace %q (Resource Group %q): `Workspace.WorkspaceProperties.Encryption.Value.KeySource` was expected to be %q, got %q", id.CustomerMangagedKeyName, id.ResourceGroup, string(databricks.MicrosoftKeyvault), keySource)
+	// }
+
+	if strings.EqualFold(keySource, string(databricks.MicrosoftKeyvault)) && (keyName == "" || keyVersion == "" || keyVaultURI == "") {
+		return fmt.Errorf("Databricks Workspace %q (Resource Group %q): `Workspace.WorkspaceProperties.Encryption.Value(s)` were nil", id.CustomerMangagedKeyName, id.ResourceGroup)
+	}
+
+	d.SetId(id.ID())
+	d.Set("workspace_id", workspaceId.ID())
+	if keyVaultURI != "" {
+		key, err := keyVaultParse.NewNestedItemID(keyVaultURI, "keys", keyName, keyVersion)
+		if err == nil {
+			d.Set("key_vault_key_id", key.ID())
+		}
+	}
+
+	return nil
+}
+
+func DatabricksWorkspaceCustomerManagedKeyDelete(d *pluginsdk.ResourceData, meta interface{}) error {
+	client := meta.(*clients.Client).DataBricks.WorkspacesClient
+	ctx, cancel := timeouts.ForRead(meta.(*clients.Client).StopContext, d)
+	defer cancel()
+
+	id, err := parse.CustomerManagedKeyID(d.Id())
+	if err != nil {
+		return err
+	}
+
+	workspaceID := parse.NewWorkspaceID(id.SubscriptionId, id.ResourceGroup, id.CustomerMangagedKeyName)
+
+	// Not sure if I should also lock the key vault here too
+	locks.ByName(workspaceID.Name, "azurerm_databricks_workspace")
+	defer locks.UnlockByName(workspaceID.Name, "azurerm_databricks_workspace")
+
+	workspace, err := client.Get(ctx, id.ResourceGroup, id.CustomerMangagedKeyName)
+	if err != nil {
+		if utils.ResponseWasNotFound(workspace.Response) {
+			log.Printf("[DEBUG] %s was not found - removing from state", *id)
+			d.SetId("")
+			return nil
+		}
+
+		return fmt.Errorf("retrieving %s: %+v", *id, err)
+	}
+
+	// Since this isn't real and you cannot turn off CMK without destroying the
+	// workspace and recreating it the best I can do is to set the workspace
+	// back to using Microsoft managed keys and removing the CMK fields
+	// also need to pull all of the custom params from the parent
+	// workspace resource and then add our new encryption values into the
+	// structure, else the other values set in the parent workspace
+	// resource will be lost and overwritten as nil. ¯\_(ツ)_/¯
+	params := workspace.Parameters
+	params.Encryption = &databricks.WorkspaceEncryptionParameter{
+		Value: &databricks.Encryption{
+			KeySource: databricks.Default,
+		},
+	}
+
+	props := databricks.Workspace{
+		Location: workspace.Location,
+		Sku:      workspace.Sku,
+		WorkspaceProperties: &databricks.WorkspaceProperties{
+			ManagedResourceGroupID: workspace.WorkspaceProperties.ManagedResourceGroupID,
+			Parameters:             params,
+		},
+		Tags: workspace.Tags,
+	}
+
+	future, err := client.CreateOrUpdate(ctx, props, workspaceID.ResourceGroup, workspaceID.Name)
+	if err != nil {
+		return fmt.Errorf("creating/updating %s: %+v", workspaceID, err)
+	}
+
+	if err = future.WaitForCompletionRef(ctx, client.Client); err != nil {
+		return fmt.Errorf("waiting for create/update of %s: %+v", workspaceID, err)
+	}
+
+	return nil
+}