Skip to content

data-platform-hq/terraform-databricks-volume

Repository files navigation

Databricks Workspace Terraform module

Terraform module used for Databricks Volumes (External by default) creation.

Usage

This module provides an ability to create Volume in Databricks Unity Catalog

module "databricks_volumes" {
  source  = "data-platform-hq/databricks-ws/volumes"
  version = "~> 1.0" 

  volume = {
    name             = "test-data-storage-eastus"
    catalog_name     = "project-catalog"
    schema_name      = "testing"
    owner            = "username@domain.com"
    comment          = "Testing Data Volume"
    storage_location = "abfss://data-test.name@$projectstorageeastus.dfs.core.windows.net"
  }
  
  permissions = [{
    principal  = "account users"
    privileges = ["READ_VOLUME"]
    }]
}

Requirements

Name Version
terraform >=1.0.0
databricks >=1.19.2

Providers

Name Version
databricks >=1.19.2

Modules

No modules.

Resources

Name Type
databricks_grants.volume resource
databricks_volume.this resource

Inputs

Name Description Type Default Required
permissions List of objects with volume permissions configuration
list(object({
principal = string
privileges = set(string)
}))
[] no
volume Configuration options for Volumes
object({
name = string
catalog_name = string
schema_name = string
storage_location = string
owner = optional(string)
volume_type = optional(string, "EXTERNAL")
comment = optional(string, "External volume provisioned by Terraform")
})
n/a yes

Outputs

Name Description
catalog_name Catalog name where volume is created
schema_name Schema name where volume is created
storage_location URL of target Storage Account Filesystem
volume_name Volume name

License

Apache 2 Licensed. For more information please see LICENSE