Merge pull request #170 from databricks-industry-solutions/feature/up…

…date_tf_documentation

TF documentation

terraform/aws/TERRAFORM_AWS.md

@@ -18,7 +18,7 @@ Step 4: Change Directories
     cd security-analysis-tool/terraform/<cloud>/
   ```
 
-Step 5: Set values in `terraform.tfvars` file
+Step 5: Generate a `terraform.tfvars` file base on `template.tfvars`
 
 Using any editor set the values in the `terraform.tfvars` file. The descriptions of all the variables are located in the variables.tf file. Once the variables are set you are ready to run Terraform.
 

terraform/aws/template.tfvars

@@ -1,11 +1,20 @@
 databricks_url       = ""
 workspace_id         = ""
 account_console_id   = ""
+
+# Should follow this format:
+# Unity Catalog: catalog.schema
+# Hive Metastore: hive_metastore.schema
 analysis_schema_name = ""
 
 ### Databricks Service Principal
-
 client_id     = "" // Databricks Service Principal Application ID
 client_secret = "" //Databricks Service Principal ID Secret
 
-proxies = {}
+# If you are behind a proxy, you can specify the proxy server here, if not leave this with the default value
+# Example:
+# {
+#   "http": "http://proxy.example.com:8080",
+#   "https": "http://proxy.example.com:8080"
+# }
+proxies = {} 

terraform/azure/TERRAFORM_Azure.md

@@ -20,7 +20,7 @@ Step 4: Change Directories
 cd security-analysis-tool/terraform/<cloud>/
 ``` 
 
-Step 5: Set values in `terraform.tfvars` file
+Step 5: Generate a `terraform.tfvars` file base on `template.tfvars`
 
 Using any editor set the values in the `terraform.tfvars` file. The descriptions of all the variables are located in the `variables.tf` file. Once the variables are set you are ready to run Terraform.
 

terraform/azure/template.tfvars

@@ -1,13 +1,22 @@
 databricks_url     = ""
 workspace_id       = ""
 account_console_id = ""
+
+# Should follow this format:
+# Unity Catalog: catalog.schema
+# Hive Metastore: hive_metastore.schema
 analysis_schema_name = ""
 
 ### Azure Specific Variables
-
 client_id       = ""
 client_secret   = ""
 tenant_id       = ""
 subscription_id = ""
 
+# If you are behind a proxy, you can specify the proxy server here, if not leave this with the default value
+# Example:
+# {
+#   "http": "http://proxy.example.com:8080",
+#   "https": "http://proxy.example.com:8080"
+# }
 proxies = {}

terraform/gcp/TERRAFORM_GCP.md

@@ -18,7 +18,7 @@ Step 4: Change Directories
 cd security-analysis-tool/terraform/<cloud>/
 ```
 
-Step 5: Set values in ``terraform.tfvars`` file
+Step 5: Generate a `terraform.tfvars` file base on `template.tfvars`
 
 Using any editor set the values in the ``terraform.tfvars`` file. The descriptions of all the variables are located in the `variables.tf` file. Once the variables are set you are ready to run Terraform.
 

terraform/gcp/template.tfvars

@@ -1,11 +1,22 @@
 databricks_url     = ""
 workspace_id       = ""
 account_console_id = ""
+
+# Should follow this format:
+# Unity Catalog: catalog.schema
+# Hive Metastore: hive_metastore.schema
 analysis_schema_name = ""
-proxies = {}
 
 ### GCP Specific Variables
 client_id                   = ""
 client_secret               = ""
 gs_path_to_json             = ""
-impersonate_service_account = ""
+impersonate_service_account = ""
+
+# If you are behind a proxy, you can specify the proxy server here, if not leave this with the default value
+# Example:
+# {
+#   "http": "http://proxy.example.com:8080",
+#   "https": "http://proxy.example.com:8080"
+# }
+proxies = {}