Terraform module Azure Data Lake

This is a module for Terraform that deploys a complete and opinionated data lake network on Microsoft Azure.

Components

Azure Data Factory for data ingestion from various sources
Azure Data Lake Storage gen2 containers to store data for the data lake layers
Azure Databricks to clean and transform the data
Azure Synapse Analytics to store presentation data
Azure CosmosDB to store metadata
Credentials and access management configured ready to go

This design is based on one of Microsoft's architecture patterns for an advanced analytics solution.

It includes some additional changes that dataroots is recommending.

Multiple storage containers to store every version of the data
Cosmos DB is used to store the metadata of the data as a Data Catalog
Azure Analysis Services is not used for now as some services might be replaced when Azure Synapse Analytics Workspace becomes GA

Usage

module "azuredatalake" {
  source  = "datarootsio/azure-datalake/module"
  version = "~> 0.1" 

  data_lake_name = "example name"
  region         = "eastus2"

  storage_replication          = "ZRS"
  service_principal_end_date   = "2030-01-01T00:00:00Z"
  cosmosdb_consistency_level   = "Session"
}

Requirements

Supported environments

This module works on macOS and Linux. Windows is not supported as the module uses some Bash scripts to get around Terraform limitations.

Azure provider configuration

The following providers have to be configured:

You can either log in through the Azure CLI, or set environment variables as documented in the links above.

Azure CLI

The module uses some workarounds for features that are not yet available in the Azure providers. Therefore, you need to be logged in to the Azure CLI as well. You can use both a user account, as well as service principal authentication.

jq

The module uses jq to extract Databricks parameters during the deployment. Therefore, you need to have jq installed.

Contributing

Contributions to this repository are very welcome! Found a bug or do you have a suggestion? Please open an issue. Do you know how to fix it? Pull requests are welcome as well! To get you started faster, a Makefile is provided.

Make sure to install Terraform, Azure CLI, Go (for automated testing) and Make (optional, if you want to use the Makefile) on your computer. Install tflint to be able to run the linting.

Setup tools & dependencies: make tools
Format your code: make fmt
Linting: make lint
Run tests: make test (or go test -timeout 2h ./... without Make)

To run the automated tests, the environment variable ARM_SUBSCRIPTION_ID has to be set to your Azure subscription ID.

License

MIT license. Please see LICENSE for details.

phuongdinh1411 / terraform-module-azure-datalake