Skip to content

feat: azure backed databricks secret scope #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2023
Merged

feat: azure backed databricks secret scope #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c1f7d4
feat: Azure-backed Databricks Secret scope
May 15, 2023
dd85f6b
fix: terraform fmt
May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,14 +251,14 @@ module "databricks_runtime_premium" {
| Name | Version |
| ---------------------------------------------------------------------------- | --------- |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
| <a name="requirement_databricks"></a> [databricks](#requirement\_databricks) | >= 1.9.2 |
| <a name="requirement_databricks"></a> [databricks](#requirement\_databricks) | >= 1.14.2 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >= 3.40.0 |

## Providers

| Name | Version |
| ---------------------------------------------------------------------- | ------- |
| <a name="provider_databricks"></a> [databricks](#provider\_databricks) | 1.9.2 |
| <a name="provider_databricks"></a> [databricks](#provider\_databricks) | 1.14.2 |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 3.40.0 |

## Modules
Expand Down Expand Up @@ -302,7 +302,8 @@ No modules.
| [databricks_secret_scope.main](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret_scope) | resource |
| [databricks_secret_scope.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret_scope) | resource |
| [databricks_secret.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret) | resource |

| [azurerm_key_vault_access_policy.databricks](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_access_policy) | resource |
| [databricks_secret_scope.external](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret_scope) | resource |



Expand Down Expand Up @@ -338,6 +339,7 @@ No modules.
| <a name="input_pat_token_lifetime_seconds"></a> [pat\_token\_lifetime\_seconds](#input\_pat\_token\_lifetime\_seconds) | The lifetime of the token, in seconds. If no lifetime is specified, the token remains valid indefinitely | `number` | 315569520 | no |
| <a name="input_mount_adls_passthrough"></a> [mount\_adls\_passthrough](#input\_mount\_adls\_passthrough) | Boolean flag to use mount options for credentals passthrough. Should be used with mount_cluster_name, specified cluster should have option cluster_conf_passthrought == true | `bool` | false | no |
| <a name="input_mount_cluster_name"></a> [mount\_cluster\_name](#input\_mount\_cluster\_name) | Name of the cluster that will be used during storage mounting. If mount_adls_passthrough == true, cluster should also have option cluster_conf_passthrought == true. When mount_cluster_name is not specified, it will create the smallest possible cluster in the default availability zone with name equal to or starting with terraform-mount for the shortest possible amount of time. | `string` | null | no |
| <a name="input_key_vault_secret_scope"></a> [key\_vault\_secret\_scope](#input\_key\_vault\_secret\_scope) | Object with Azure Key Vault parameters required for creation of Azure-backed Databricks Secret scope. | <pre>object({<br> key_vault_id = string<br> dns_name = string<br>})<br></pre> | <pre>{<br> key_vault_id = null<br> dns_name = null<br>}</pre> | no |



Expand Down
48 changes: 22 additions & 26 deletions secrets.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,31 +44,27 @@ resource "databricks_secret" "this" {
scope = databricks_secret_scope.this[each.value.scope_name].id
}

# At the nearest future, Azure will allow acquiring AAD tokens by service principals,
# thus providing an ability to create Azure backed Key Vault with Terraform
# https://github.com/databricks/terraform-provider-databricks/pull/1965
# Azure Key Vault-backed Scope
resource "azurerm_key_vault_access_policy" "databricks" {
count = var.key_vault_secret_scope.key_vault_id != null ? 1 : 0

## Azure Key Vault-backed Scope
#resource "azurerm_key_vault_access_policy" "databricks" {
# count = var.key_vault_secret_scope.key_vault_id != null ? 1 : 0
key_vault_id = var.key_vault_secret_scope.key_vault_id
object_id = "9b38785a-6e08-4087-a0c4-20634343f21f" # Global 'AzureDatabricks' SP object id
tenant_id = data.azurerm_key_vault_secret.tenant_id.value

# key_vault_id = var.key_vault_secret_scope.key_vault_id
# object_id = "9b38785a-6e08-4087-a0c4-20634343f21f" # Global 'AzureDatabricks' SP object id
# tenant_id = data.azurerm_key_vault_secret.tenant_id.value
#
# secret_permissions = [
# "Get",
# "List",
# ]
#}
#
#resource "databricks_secret_scope" "external" {
# count = var.key_vault_secret_scope.key_vault_id != null ? 1 : 0
#
# name = "external"
# keyvault_metadata {
# resource_id = var.key_vault_secret_scope.key_vault_id
# dns_name = var.key_vault_secret_scope.dns_name
# }
# depends_on = [azurerm_key_vault_access_policy.databricks]
#}
secret_permissions = [
"Get",
"List",
]
}

resource "databricks_secret_scope" "external" {
count = var.key_vault_secret_scope.key_vault_id != null ? 1 : 0

name = "external"
keyvault_metadata {
resource_id = var.key_vault_secret_scope.key_vault_id
dns_name = var.key_vault_secret_scope.dns_name
}
depends_on = [azurerm_key_vault_access_policy.databricks]
}
12 changes: 12 additions & 0 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,3 +265,15 @@ variable "mount_cluster_name" {
description = "Name of the cluster that will be used during storage mounting. If mount_adls_passthrough == true, cluster should also have option cluster_conf_passthrought == true"
default = null
}

variable "key_vault_secret_scope" {
type = object({
key_vault_id = string
dns_name = string
})
description = "Object with Azure Key Vault parameters required for creation of Azure-backed Databricks Secret scope"
default = {
key_vault_id = null
dns_name = null
}
}
2 changes: 1 addition & 1 deletion versions.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ terraform {
}
databricks = {
source = "databricks/databricks"
version = ">=1.9.2"
version = ">=1.14.2"
}
}
}