{"id":14957868,"url":"https://github.com/databricks/terraform-databricks-examples","last_synced_at":"2025-05-16T00:00:33.177Z","repository":{"id":37800750,"uuid":"502013061","full_name":"databricks/terraform-databricks-examples","owner":"databricks","description":"Examples of using Terraform to deploy Databricks resources ","archived":false,"fork":false,"pushed_at":"2025-04-24T11:56:19.000Z","size":18190,"stargazers_count":257,"open_issues_count":55,"forks_count":154,"subscribers_count":75,"default_branch":"main","last_synced_at":"2025-05-15T23:55:43.859Z","etag":null,"topics":["aws","azure","databricks","databricks-module","gcp","lakehouse","terraform","terraform-module"],"latest_commit_sha":null,"homepage":"https://registry.terraform.io/modules/databricks/examples/databricks/latest","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/databricks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-10T11:12:00.000Z","updated_at":"2025-05-10T22:43:56.000Z","dependencies_parsed_at":"2023-02-14T14:15:56.735Z","dependency_job_id":"91314c67-7150-44bc-926b-c9ae48460eb8","html_url":"https://github.com/databricks/terraform-databricks-examples","commit_stats":{"total_commits":157,"total_committers":33,"mean_commits":4.757575757575758,"dds":0.6751592356687899,"last_synced_commit":"057173d179ae03364594059adb133be3e8153ad3"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fterraform-databricks-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fterraform-databricks-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fterraform-databricks-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fterraform-databricks-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/databricks","download_url":"https://codeload.github.com/databricks/terraform-databricks-examples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","azure","databricks","databricks-module","gcp","lakehouse","terraform","terraform-module"],"created_at":"2024-09-24T13:15:44.253Z","updated_at":"2025-05-16T00:00:33.114Z","avatar_url":"https://github.com/databricks.png","language":"HCL","readme":"# terraform-databricks-examples\n\nThis repository contains the following:\n\n- Multiple examples of Databricks workspace and resources deployment on Azure, AWS and GCP using [Databricks Terraform provider](https://registry.terraform.io/providers/databricks/databricks/latest/docs).\n- Examples of implementing CI/CD pipelines to automate your Terraform deployments using Azure DevOps or GitHub Actions.\n\n* [Using the repository](#using-the-repository)\n* [Repository structure](#repository-structure)\n* [Repository content](#repository-content)\n   * [Examples](#examples)\n   * [Modules](#modules)\n   * [CI/CD pipelines](#cicd-pipelines)\n* [Contributing](#contributing)\n\n## Using the repository\n\nThere are two ways to use this repository:\n\n1. Use examples as a reference for your own Terraform code: Please refer to `examples` folder for individual examples.\n2. Reuse modules from this repository: Please refer to `modules` folder.\n\n## Repository structure\n\nCode in the repository is organized into the following folders:\n\n- `modules` - implementation of specific Terraform modules.\n- `examples` - specific instances that use Terraform modules.\n- `cicd-pipelines` - Detailed examples of implementing CI/CD pipelines to automate your Terraform deployments using Azure DevOps or GitHub Actions.\n\n## Repository content\n\n\u003e **Note**  \n\u003e For detailed information about the examples, modules, or CI/CD pipelines, refer to `README.md` file inside the corresponding folder for a detailed guide on setting up the CI/CD pipeline.\n\n### Examples\n\nThe folder `examples` contains the following Terraform implementation examples :\n\n| Cloud | Example                                                                            | Description                                                                                                                                                   |\n| ----- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|Azure | [adb-lakehouse](examples/adb-lakehouse/)         | Lakehouse terraform blueprints|\n| Azure | [adb-with-private-link-standard](examples/adb-with-private-link-standard/)         | Provisioning Databricks on Azure with Private Link - [Standard deployment](https://learn.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/private-link-standard) |\n| Azure | [adb-vnet-injection](examples/adb-vnet-injection/)                                 | A basic example of VNet injected Azure Databricks workspace                                                                                                                                          |\n| Azure | [adb-exfiltration-protection](examples/adb-exfiltration-protection/)               | A sample implementation of [Data Exfiltration Protection](https://www.databricks.com/blog/2020/03/27/data-exfiltration-protection-with-azure-databricks.html)                                        |\n| Azure | [adb-external-hive-metastore](examples/adb-external-hive-metastore/)               | Example template to implement [external hive metastore](https://learn.microsoft.com/en-us/azure/databricks/data/metastores/external-hive-metastore)                                                  |\n| Azure | [adb-kafka](examples/adb-kafka/)                                                   | ADB - single node kafka template                                                                                                                                                                     |\n| Azure | [adb-private-links](examples/adb-private-links/)                                   | Azure Databricks Private Links                                                                                                                                                                       |\n| Azure | [adb-squid-proxy](examples/adb-squid-proxy/)                                       | ADB clusters with HTTP proxy                                                                                                                                                                         |\n| Azure | [adb-teradata](examples/adb-teradata/)                                             | ADB with single VM Teradata integration                                                                                                                                                              |\n| Azure | [adb-uc](examples/adb-uc/)                                                         | ADB Unity Catalog Process                                                                                                                                                                            |\n| Azure | [adb-unity-catalog-basic-demo](examples/adb-unity-catalog-basic-demo/)             | ADB Unity Catalog end-to-end demo including UC metastore setup, Users/groups sync from AAD to databricks account, UC Catalog, External locations, Schemas, \u0026 Access Grants                           |\n| Azure | [adb-overwatch](examples/adb-overwatch/)             | Overwatch multi-workspace deployment on Azure                          |\n| AWS   | [aws-workspace-basic](examples/aws-workspace-basic/)                               | Provisioning AWS Databricks E2                                                                                                                                                                       |\n| AWS   | [aws-workspace-with-firewall](examples/aws-workspace-with-firewall/)               | Provisioning AWS Databricks E2 with an AWS Firewall                                                                                                                                                  |\n| AWS   | [aws-exfiltration-protection](examples/aws-exfiltration-protection/)               | An implementation of [Data Exfiltration Protection on AWS](https://www.databricks.com/blog/2021/02/02/data-exfiltration-protection-with-databricks-on-aws.html)                                      |\n| AWS   | aws-workspace-with-private-link                                                    | Coming soon                                                                                                                                                                                          |\n| AWS   | [aws-databricks-flat](examples/aws-databricks-flat/)                               | AWS Databricks simple example                                                                                                                                                                        |\n| AWS   | [aws-databricks-modular-privatelink](examples/aws-databricks-modular-privatelink/) | Deploy multiple AWS Databricks workspaces                                                                                                                                                            |\n| AWS   | [aws-workspace-uc-simple](examples/aws-workspace-uc-simple/)                       | Provisioning AWS Databricks E2 with Unity Catalog in a single apply                                                                                                                                                                                               |\n| AWS   | [aws-databricks-uc](examples/aws-databricks-uc/)                                   | AWS UC                                                                                                                                                                                               |\n| AWS   | [aws-databricks-uc-bootstrap](examples/aws-databricks-uc-bootstrap/)               | AWS UC                                                                                                                                                                                               |\n| AWS   | [aws-remote-backend-infra](examples/aws-remote-backend-infra/)                     | Simple example on remote backend                                                                                                                                                                     |\n| AWS   | [aws-workspace-config](examples/aws-workspace-config/)                             | Configure workspace objects                                                                                 |\n| GCP   | [gcp-sa-provisionning](examples/gcp-sa-provisionning/)                                                                         |    Provisionning of the identity with the permissions required to deploy on GCP.                                                                                                                                 |\n| GCP   | [gcp-basic](examples/gcp-basic/)                                                                         |    Workspace Deployment with managed vpc                                                                                                                               |\n| GCP   | [gcp-byovpc](examples/gcp-byovpc/)                                                                         |    Workspace Deployment with customer-managed vpc                                                                                                                              |\n### Modules\n\nThe folder `modules` contains the following Terraform modules :\n\n| Cloud | Module                                                                                                    | Description                                                                                                                                                                               |\n| ----- |-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| All   | [databricks-department-clusters](modules/databricks-department-clusters/)                                 | Terraform module that creates Databricks resources for a team                                                                                                                             |\n| Azure | [adb-lakehouse](modules/adb-lakehouse/)                                                                   | Lakehouse terraform blueprints                                                                                                                                                            |\n| Azure | [adb-lakehouse-uc](modules/adb-lakehouse-uc/)                                                             | Provisioning Unity Catalog resources and accounts principals                                                                                                                              |\n| Azure | [adb-with-private-link-standard](modules/adb-with-private-link-standard/)                                 | Provisioning Databricks on Azure with Private Link - Standard deployment                                                                                                                  |\n| Azure | [adb-exfiltration-protection](modules/adb-exfiltration-protection/)                                       | A sample implementation of [Data Exfiltration Protection](https://www.databricks.com/blog/2020/03/27/data-exfiltration-protection-with-azure-databricks.html)                             |\n| Azure | [adb-with-private-links-exfiltration-protection](modules/adb-with-private-links-exfiltration-protection/) | Provisioning Databricks on Azure with Private Link and [Data Exfiltration Protection](https://www.databricks.com/blog/2020/03/27/data-exfiltration-protection-with-azure-databricks.html) |\n| Azure | [adb-overwatch-regional-config](modules/adb-overwatch-regional-config/)                                   | Overwatch regional configuration on Azure                                                                                                                                                 |\n| Azure | [adb-overwatch-mws-config](modules/adb-overwatch-mws-config/)                                             | Overwatch multi-workspace deployment on Azure                                                                                                                                             |\n| Azure | [adb-overwatch-main-ws](modules/adb-overwatch-main-ws/)                                                   | Main Overwatch workspace deployment                                                                                                                                                       |\n| Azure | [adb-overwatch-ws-to-monitor](modules/adb-overwatch-ws-to-monitor/)                                       | Overwatch deployment on the Azure workspace to monitor                                                                                                                                    |\n| Azure | [adb-overwatch-analysis](modules/adb-overwatch-analysis/)                                                 | Overwatch analysis notebooks deployment on Azure                                                                                                                                          |\n| AWS   | [aws-workspace-basic](modules/aws-workspace-basic/)                                                       | Provisioning AWS Databricks E2                                                                                                                                                            |\n| AWS   | [aws-databricks-base-infra](modules/aws-databricks-base-infra/)                                           | Provisioning AWS Infrastructure to be used for the deployment of a Databricks E2 workspace                                                                                                |\n| AWS   | [aws-databricks-unity-catalog](modules/aws-databricks-unity-catalog/)                                     | Provisioning the AWS Infrastructure and setting up the metastore for Databricks Unity Catalog                                                                                             |\n| AWS   | [aws-databricks-workspace](modules/aws-databricks-workspace/)                                             | Provisioning AWS Databricks E2 Workspace using pre-created AWS Infra                                                                                                                      |\n| AWS   | [aws-workspace-with-firewall](modules/aws-workspace-with-firewall/)                                       | Provisioning AWS Databricks E2 with an AWS Firewall                                                                                                                                       |\n| AWS   | [aws-exfiltration-protection](modules/aws-exfiltration-protection/)                                       | An implementation of [Data Exfiltration Protection on AWS](https://www.databricks.com/blog/2021/02/02/data-exfiltration-protection-with-databricks-on-aws.html)                           |\n| AWS   | aws-workspace-with-private-link                                                                           | Coming soon                                                                                                                                                                               |\n| GCP   | [gcp-sa-provisionning](modules/gcp-sa-provisionning/)                                                                                                |                  Provisions the identity (SA) with the correct permissions  |\n| GCP   | [gcp-workspace-basic](modules/gcp-workspace-basic/)                                                                                                |                  Provisions a workspace with managed VPC                                                                                                                                                          |\n| GCP   | [gcp-workspace-byovpc](modules/gcp-workspace-byovpc/)                                                                                                |                  Workspace with customer-managed VPC.                                                                                                                                                             |\n### CI/CD pipelines\n\nThe `cicd-pipelines` folder contains the following implementation examples of pipeline:\n\n| Tool           | CI/CD Pipeline                                                                           |\n| -------------- | ---------------------------------------------------------------------------------------- |\n| GitHub Actions | [manual-approve-with-github-actions](cicd-pipelines/manual-approve-with-github-actions/) |\n| Azure DevOps   | [manual-approve-with-azure-devops](cicd-pipelines/manual-approve-with-azure-devops/)     |\n\n## Contributing\n\nWhen contributing the new code, please follow the structure described in the [Repository content](#repository-content) section:\n\n* The reusable code should go into the `modules` directory to be easily included when it's published to the Terraform registry.  Prefer to implement the modular design consisting of multiple smaller modules implementing a specific functionality vs. one big module that does everything.  For example, a separate module for Unity Catalog objects could be used across all clouds, so we won't need to reimplement the same functionality in cloud-specific modules.\n* Provide examples of module usage in the `examples` directory - it should show how to use the given module(s).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabricks%2Fterraform-databricks-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatabricks%2Fterraform-databricks-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabricks%2Fterraform-databricks-examples/lists"}