Skip to content

Latest commit

 

History

History
89 lines (54 loc) · 4.03 KB

TERRAFORM_GCP.md

File metadata and controls

89 lines (54 loc) · 4.03 KB
Raw

Setting up Terraform

SAT v0.2.0 or higher brings full support for Unity Catalog. Now you can pick your catalog instead of hive_metastore. Plus, you get to choose your own schema name.

Step 1: Install Terraform

Step 2: Install Git on local machine

Step 3: Git Clone Repo

git clone https://github.com/databricks-industry-solutions/security-analysis-tool.git

Step 4: Change Directories

cd security-analysis-tool/terraform/<cloud>/

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.

Further Documentation for some of the variables:

workspace_id

account_console_id

GCP Specific variables and navigate to the GCP section

Proxies are now supported as part of SAT. You can add your HTTP and HTTPS links to use your proxies.

{
    "http": "http://example.com",
    "https": "https://example.com"
}

Run Terraform

Step 6: Terraform Init

The terraform init command initializes a working directory containing configuration files and installs plugins for required providers.

terraform init

Step 7: Terraform Plan

The terraform plan command creates an execution plan, which lets you preview the changes that Terraform plans to make to your infrastructure. By default, when Terraform creates a plan it:

  • Reads the current state of any already-existing remote objects to make sure that the Terraform state is up-to-date.
  • Compares the current configuration to the prior state and noting any differences.
  • Proposes a set of change actions that should, if applied, make the remote objects match the configuration.
terraform plan

Step 8: Terraform Apply

The terraform apply command executes the actions proposed in a Terraform plan.

terraform apply

Step 9: Run Jobs

You now have two jobs ("SAT Initializer Notebook" & "SAT Driver Notebook"). Run "SAT Initializer Notebook" and when it completes run "SAT Driver Notebook". "SAT Initializer Notebook" should only be run once (although you can run it multiple times, it only needs to be run successfully one time), and "SAT Driver Notebook" can be run periodically (its scheduled to run once every Monday, Wednesday, and Friday).

Step 10: SAT Dashboard

Go to the SQL persona, select the Dashboard icon in the left menu and then select the SAT Dashboard. Once the dashboard loads pick the Workspace from the dropdown and refresh the dashboard

Supplemental Documentation:

Databricks Documentation Terraform

Databricks Terraform Provider Docs

Additional Considerations:

Your jobs may fail if there was a pre-existing secret scope named sat_scope when you run terraform apply. To remedy this, you will need to change the name of your secret scope in secrets.tf, re-run terraform apply, and then navigate to Workspace -> Applications -> SAT-TF /notebooks/Utils/initialize and change the secret scope name in 6 places (3 times in CMD 4 and 3 times in CMD 5). You then can re-run your failed jobs.

Congratulations!!! Please review the setup documentation for the instructions on usage, FAQs and general understanding of SAT setup