README
¶
datatf
Export existing Azure Databricks platform configuration into Terraform files, ready for import. DataTF reads your workspace and writes local files. It never reads secret values or applies Terraform.
Install
macOS and Linux:
curl -fsSL https://datatf.io/install.sh | sh
Windows PowerShell:
irm https://datatf.io/install.ps1 | iex
The script verifies the release checksum and installs one binary. See the install guide for manual downloads, macOS Gatekeeper, and source builds.
Quick start
If you already have a profile, skip sign-in and replace analytics with its name.
- Install the Databricks CLI.
- Check the required read permissions.
- Sign in to your Azure Databricks workspace. Replace
<workspace-url>with its URL:
databricks auth login --host "<workspace-url>" --profile analytics
- Confirm the profile URL, then export into a new directory:
databricks auth profiles
datatf auth status --profile analytics
datatf export --profile analytics --out ./export --scaffold
Open export/README.md for the Terraform import steps.
Review the export report and Terraform plan before you apply it. Require imports only, with no resource changes.
The default export covers workspace-owned resources. For shared Unity Catalog objects, see scopes and state ownership.
Resource coverage
Only the Terraform resources in this table are supported.
--resources group |
Terraform resources | Scope |
|---|---|---|
catalogs |
databricks_catalog, databricks_schema, databricks_grants |
Workspace or shared |
storage_credentials |
databricks_storage_credential, databricks_grants |
Workspace or shared |
external_locations |
databricks_external_location, databricks_grants |
Workspace or shared |
| Included with the three groups above | databricks_workspace_binding |
Workspace or shared |
cluster_policies |
databricks_cluster_policy, databricks_permissions |
Workspace |
instance_pools |
databricks_instance_pool, databricks_permissions |
Workspace |
warehouses |
databricks_sql_endpoint, databricks_permissions |
Workspace |
secret_scopes |
databricks_secret_scope, databricks_secret_acl |
Workspace |
service_principals |
databricks_service_principal |
Workspace |
DataTF does not export Azure infrastructure, account or metastore setup, workloads, stored data, or secret values.
Documentation
- Select resources or choose a module layout.
- Troubleshooting, upgrades, and telemetry.
- Contributing and changelog.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
datatf
command
|
|
|
internal
|
|
|
cli
Package cli wires the datatf commands.
|
Package cli wires the datatf commands. |
|
contract
Package contract turns an inventory into the datatf Terraform module contract: tfvars values, import blocks, and the export report.
|
Package contract turns an inventory into the datatf Terraform module contract: tfvars values, import blocks, and the export report. |
|
diagnostic
Package diagnostic gives read failures stable codes and safe recovery hints.
|
Package diagnostic gives read failures stable codes and safe recovery hints. |
|
emit
Package emit writes export artifacts to disk.
|
Package emit writes export artifacts to disk. |
|
fakews
Package fakews serves recorded Databricks API fixtures over httptest so the reader and contract can be tested end to end without a workspace.
|
Package fakews serves recorded Databricks API fixtures over httptest so the reader and contract can be tested end to end without a workspace. |
|
fakews/cmd/fakewsd
command
fakewsd serves the recorded fake workspace on a fixed port so terraform and datatf can be pointed at it during local end-to-end checks:
|
fakewsd serves the recorded fake workspace on a fixed port so terraform and datatf can be pointed at it during local end-to-end checks: |
|
inventory
Package inventory reads a Databricks workspace into a typed, read-only model and classifies every object by who should own it in Terraform.
|
Package inventory reads a Databricks workspace into a typed, read-only model and classifies every object by who should own it in Terraform. |
|
scaffold
Package scaffold renders a Terraform root for the DataTF module contract.
|
Package scaffold renders a Terraform root for the DataTF module contract. |
|
telemetry
Package telemetry builds opt-in usage events without workspace metadata.
|
Package telemetry builds opt-in usage events without workspace metadata. |
|
update
Package update checks public release metadata without credentials or usage events.
|
Package update checks public release metadata without credentials or usage events. |