Improve modules - descriptions & types for variables (#106)

Also reformatted code

Author: alexott

examples/adb-exfiltration-protection/variables.tf

@@ -1,64 +1,64 @@
 variable "hubcidr" {
   description = "IP range for creaiton of the Spoke VNet"
-  type    = string
-  default = "10.178.0.0/20"
+  type        = string
+  default     = "10.178.0.0/20"
 }
 
 variable "spokecidr" {
   description = "IP range for creaiton of the Hub VNet"
-  type    = string
-  default = "10.179.0.0/20"
+  type        = string
+  default     = "10.179.0.0/20"
 }
 
 variable "no_public_ip" {
   description = "If workspace should be created with No-Public-IP"
-  type    = bool
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "rglocation" {
   description = "Location of resource group"
-  type    = string
+  type        = string
 }
 
 variable "metastore" {
   description = "List of FQDNs for Azure Databricks Metastore databases"
-  type = list(string)
+  type        = list(string)
 }
 
 variable "scc_relay" {
   description = "List of FQDNs for Azure Databricks Secure Cluster Connectivity relay"
-  type = list(string)
+  type        = list(string)
 }
 
 variable "webapp_ips" {
   description = "List of IP ranges for Azure Databricks Webapp"
-  type = list(string)
+  type        = list(string)
 }
 
 variable "extended_infra_ip" {
   description = "IP range for Azure Databricks extended infrastructure"
-  type = string
+  type        = string
 }
 
 variable "eventhubs" {
   description = "List of FQDNs for Azure Databricks EventHubs traffic"
-  type = list(string)
+  type        = list(string)
 }
 
 variable "dbfs_prefix" {
   description = "Prefix for DBFS storage account name"
-  type    = string
-  default = "dbfs"
+  type        = string
+  default     = "dbfs"
 }
 
 variable "workspace_prefix" {
   description = "Prefix for workspace name"
-  type    = string
-  default = "adb"
+  type        = string
+  default     = "adb"
 }
 
 variable "firewallfqdn" {
-  type = list(any)
+  type        = list(any)
   description = "List of domains names to put into application rules for handling of HTTPS traffic (Databricks storage accounts, etc.)"
 }

examples/adb-external-hive-metastore/main.tf

@@ -22,7 +22,7 @@ data "external" "me" {
 
 # Retrieve information about the current user (the caller of tf apply)
 data "databricks_current_user" "me" {
-  depends_on    = [azurerm_databricks_workspace.this]
+  depends_on = [azurerm_databricks_workspace.this]
 }
 
 data "databricks_spark_version" "latest_lts" {

examples/adb-lakehouse/main.tf

@@ -28,7 +28,7 @@ module "adb-lakehouse-uc-metastore" {
   metastore_id           = module.adb-lakehouse-uc-metastore.metastore_id
   workspace_id           = module.adb-lakehouse.workspace_id
   metastore_admins       = var.metastore_admins
-  providers              = {
+  providers = {
     databricks = databricks.workspace
   }
 }
@@ -39,7 +39,7 @@ module "adb-lakehouse-uc-account-principals" {
   workspace_id       = module.adb-lakehouse.workspace_id
   service_principals = var.service_principals
   account_groups     = var.account_groups
-  providers          = {
+  providers = {
     databricks = databricks.account
   }
 }
@@ -55,7 +55,7 @@ module "adb-lakehouse-data-assets" {
   landing_adls_path              = var.landing_adls_path
   landing_adls_rg                = var.landing_adls_rg
   metastore_admins               = var.metastore_admins
-  providers                      = {
+  providers = {
     databricks = databricks.workspace
   }
 }

examples/adb-unity-catalog-basic-demo/main.tf

@@ -204,7 +204,7 @@ resource "databricks_grants" "silver" {
   }
 }
 
- // Create schema for gold datalake layer in dev env.
+// Create schema for gold datalake layer in dev env.
 resource "databricks_schema" "gold" {
   catalog_name = databricks_catalog.dev.id
   name         = "gold"

examples/adb-with-private-link-standard/outputs.tf

@@ -1,5 +1,5 @@
 output "test_vm_password" {
   description = "Password to access the Test VM, use `terraform output -json test_vm_password` to get the password value"
-  value = module.adb-with-private-link-standard.test_vm_password
-  sensitive = true
+  value       = module.adb-with-private-link-standard.test_vm_password
+  sensitive   = true
 }

examples/aws-databricks-modular-privatelink/variables.tf

@@ -7,12 +7,14 @@ variable "databricks_account_password" {
 }
 
 variable "databricks_account_id" {
-  type = string
+  type        = string
+  description = "Databricks Account ID"
 }
 
 variable "region" {
-  type    = string
-  default = "ap-southeast-1"
+  type        = string
+  description = "AWS region to deploy to"
+  default     = "ap-southeast-1"
 }
 
 #cmk
@@ -22,7 +24,9 @@ variable "cmk_admin" {
 }
 
 variable "tags" {
-  default = {}
+  default     = {}
+  type        = map(string)
+  description = "Optional tags to add to created resources"
 }
 
 variable "vpc_cidr" {

examples/aws-databricks-uc-bootstrap/variables.tf

@@ -7,7 +7,8 @@ variable "databricks_account_password" {
 }
 
 variable "databricks_account_id" {
-  type = string
+  type        = string
+  description = "Databricks Account ID"
 }
 
 variable "databricks_users" {

examples/aws-databricks-uc/variables.tf

@@ -7,16 +7,20 @@ variable "databricks_account_password" {
 }
 
 variable "databricks_account_id" {
-  type = string
+  type        = string
+  description = "Databricks Account ID"
 }
 
 variable "region" {
-  type    = string
-  default = "ap-southeast-1"
+  type        = string
+  description = "AWS region to deploy to"
+  default     = "ap-southeast-1"
 }
 
 variable "tags" {
-  default = {}
+  default     = {}
+  type        = map(string)
+  description = "Optional tags to add to created resources"
 }
 
 variable "databricks_workspace_ids" {

examples/aws-exfiltration-protection/main.tf

@@ -3,4 +3,10 @@ module "aws-exfiltration-protection" {
   databricks_account_id       = var.databricks_account_id
   databricks_account_username = var.databricks_account_username
   databricks_account_password = var.databricks_account_password
-}
+}
+
+resource "random_string" "naming" {
+  special = false
+  upper   = false
+  length  = 6
+}

examples/aws-exfiltration-protection/variables.tf

@@ -1,46 +1,67 @@
 variable "databricks_account_username" {}
 variable "databricks_account_password" {}
-variable "databricks_account_id" {}
+
+variable "databricks_account_id" {
+  type        = string
+  description = "Databricks Account ID"
+}
 
 variable "tags" {
-  default = {}
+  default     = {}
+  type        = map(string)
+  description = "Optional tags to add to created resources"
 }
 
 variable "spoke_cidr_block" {
-  default = "10.173.0.0/16"
+  default     = "10.173.0.0/16"
+  description = "IP range for spoke AWS VPC"
+  type        = string
 }
+
 variable "hub_cidr_block" {
-  default = "10.10.0.0/16"
+  default     = "10.10.0.0/16"
+  description = "IP range for hub AWS VPC"
+  type        = string
 }
+
 variable "region" {
-  default = "eu-central-1"
+  default     = "eu-central-1"
+  type        = string
+  description = "AWS region to deploy to"
 }
 
-resource "random_string" "naming" {
-  special = false
-  upper   = false
-  length  = 6
-}
 variable "whitelisted_urls" {
-  default = [".pypi.org", ".pythonhosted.org", ".cran.r-project.org"]
+  default     = [".pypi.org", ".pythonhosted.org", ".cran.r-project.org"]
+  description = "List of the domains to allow traffic to"
+  type        = list(string)
 }
 
 variable "db_web_app" {
-  default = "frankfurt.cloud.databricks.com"
+  default     = "frankfurt.cloud.databricks.com"
+  description = "Hostname of Databricks web application"
+  type        = string
 }
 
 variable "db_tunnel" {
-  default = "tunnel.eu-central-1.cloud.databricks.com"
+  default     = "tunnel.eu-central-1.cloud.databricks.com"
+  description = "Hostname of Databricks SCC Relay"
+  type        = string
 }
 
 variable "db_rds" {
-  default = "mdv2llxgl8lou0.ceptxxgorjrc.eu-central-1.rds.amazonaws.com"
+  default     = "mdv2llxgl8lou0.ceptxxgorjrc.eu-central-1.rds.amazonaws.com"
+  description = "Hostname of AWS RDS instance for built-in Hive Metastore"
+  type        = string
 }
 
 variable "db_control_plane" {
-  default = "18.159.44.32/28"
+  default     = "18.159.44.32/28"
+  description = "IP Range for AWS Databricks control plane"
+  type        = string
 }
 
 variable "prefix" {
-  default = "demo"
-}
+  default     = "demo"
+  type        = string
+  description = "Prefix for use in the generated names"
+}