Lakebase 向け Terraform を使い始める
このガイドは、Databricks Terraform プロバイダーを使用して Lakebase リソースを管理するための Terraform の使用を開始するのに役立ちます。プロジェクトを作成し、開発ブランチとエンドポイントを追加し、完了したらそれらを削除します。これは、開発環境とテスト環境を管理するための一般的なワークフローです。
完全なリソース リファレンスと使用可能なすべての構成オプションについては、 Terraform Registry の Databricks プロバイダーのドキュメントを参照してください。
前提条件
始める前に、次のものが必要です。
- Terraform がインストールされている (バージョン 1.0 以上)。「Terraform のインストール」を参照してください。
- Lakebase プロジェクトに対するCAN MANAGE権限を持つOAuthマシン間 (M2M) 認証用に構成されたサービスプリンシパル。 このガイドでは、プロジェクト内のすべてのリソースを管理するためのこれらの権限を持つサービスプリンシパルを作成しました。 OAuthを使用したDatabricksへのサービスプリンシパル アクセスの承認」および「プロジェクト権限の管理」を参照してください。
Lakebase オートスケールTerraformセマンティクス
Lakebase オートスケール リソースは、宣言的な状態管理のために仕様/ステータス フィールドを持つTerraformセマンティクスを使用します。 specフィールドは希望する状態を定義し、 statusフィールドは現在の状態を表示します。
重要: ドリフト検出と Terraform 外部の変更
Terraform の外部 (UI、CLI、または API を使用) で Lakebase リソースに加えられた変更は、Terraform の標準ドリフト検出では検出されません。
spec/status フィールドの動作、ドリフト検出の動作、および状態管理の要件の詳細については、 databricks_postgres_projectリソースのドキュメントを参照してください。
リソース階層
Lakebase リソース階層を理解すると、Terraform での依存関係の管理に役立ちます。リソースには親子関係があります。子よりも先に親リソースを作成し、親よりも前に子を削除します。
Project
└── Branches (main, development, staging, etc.)
├── Endpoints (compute for executing queries)
├── Roles (Postgres roles)
└── Databases (Postgres databases)
このクイックスタートでは、最初にプロジェクトを作成し、次に開発ブランチを作成し、最後に開発ブランチのエンドポイントを作成することで、この階層に従います。ブランチを使用すると、分離された開発およびテスト環境を作成し、現実的なデータ セットに対してアプリケーションをテストできます。
クイックスタート: Terraform を使用して Lakebase プロジェクトを管理する
次のステップに従って、開発ブランチとコンピュート エンドポイントを含む完全に動作するプロジェクトを作成します。
1.認証を設定する
前提条件で構成したサービスプリンシパルを使用して認証するようにDatabricksプロバイダーを構成します。 Lakebase リソースにはOAuth認証が必要なので、サービスプリンシパルのOAuth資格情報の環境変数を設定します。
export DATABRICKS_HOST="https://your-workspace.cloud.databricks.com"
export DATABRICKS_CLIENT_ID="your-service-principal-client-id"
export DATABRICKS_CLIENT_SECRET="your-service-principal-secret"
次に、次の環境変数を使用するようにプロバイダーを構成します。
terraform {
required_version = ">= 1.0"
required_providers {
databricks = {
source = "databricks/databricks"
version = "~> 1.0"
}
}
}
provider "databricks" {
# Automatically uses DATABRICKS_HOST, DATABRICKS_CLIENT_ID,
# and DATABRICKS_CLIENT_SECRET from environment variables
}
認証オプションとOAuth構成の詳細については、 OAuthを使用したDatabricksへのサービス プリンシパル アクセスの承認」およびDatabricks Terraformプロバイダー」を参照してください。
2. プロジェクトを作成する
プロジェクトは、ブランチ、エンドポイント、データベース、およびロールを含む最上位のリソースです。
プロジェクトを作成すると、 Databricks読み書き可能なコンピュート エンドポイントを使用してまだ本番運用ブランチを自動的にプロビジョニングします。 ブランチとエンドポイントはどちらも自動生成された ID を使用して作成されます。
基本的なプロジェクトを作成します。
resource "databricks_postgres_project" "app" {
project_id = "my-app"
spec = {
pg_version = 17
display_name = "My Application"
}
}
次のコマンドを実行して構成をフォーマットし、プロジェクトを作成します。
terraform fmt
terraform apply
3. プロジェクトを取得する
データソースを使用して、作成したばかりのプロジェクトに関する情報を取得します。
data "databricks_postgres_project" "this" {
name = databricks_postgres_project.app.name
}
output "project_name" {
value = data.databricks_postgres_project.this.name
}
output "project_pg_version" {
value = try(data.databricks_postgres_project.this.status.pg_version, null)
}
output "project_display_name" {
value = try(data.databricks_postgres_project.this.status.display_name, null)
}
データソースは、 statusフィールドの値を返します。 すべてのプロバイダー バージョンで使用できない可能性があるフィールドに安全にアクセスするには、 try()を使用します。
構成を適用し、プロジェクトの詳細を表示するには、次のコマンドを実行します。
terraform apply
terraform output
4. ブランチを作成する
ブランチは、プロジェクト内で分離されたデータベース環境を提供します。
残り本番運用ブランチはプロジェクトとともに自動的に作成され、読み取り/書き込みエンドポイントが含まれます。 開発、ステージング、またはその他の環境用に追加のブランチを作成しても、エンドポイントは自動的には含まれません。ステップ 5 に示すように、エンドポイントを作成する必要があります。
この例では、開発ブランチを作成します。
resource "databricks_postgres_branch" "dev" {
branch_id = "dev"
parent = databricks_postgres_project.app.name
spec = {
no_expiry = true
}
}
output "dev_branch_name" {
value = databricks_postgres_branch.dev.name
}
ブランチを作成し、その名前を表示するには、次のコマンドを実行します。
terraform apply
terraform output dev_branch_name
5.エンドポイントを作成する
エンドポイントは、ブランチに対してクエリを実行するためのコンピュート リソースを提供します。
プロジェクトで作成された本番運用ブランチには、すでに読み取り/書き込みエンドポイントが含まれています。 このセクションでは、前のステップで作成した開発ブランチのエンドポイントを作成する方法を説明します。
dev ブランチの読み取り/書き込みエンドポイントを作成します。
resource "databricks_postgres_endpoint" "dev_primary" {
endpoint_id = "primary"
parent = databricks_postgres_branch.dev.name
spec = {
endpoint_type = "ENDPOINT_TYPE_READ_WRITE"
}
}
output "dev_endpoint_name" {
value = databricks_postgres_endpoint.dev_primary.name
}
エンドポイントを作成し、その名前を表示するには、次のコマンドを実行します。
terraform apply
terraform output dev_endpoint_name
6. エンドポイントを一覧表示する
開発ブランチ内のエンドポイントを一覧表示して、作成した読み取り/書き込みエンドポイントの詳細を表示します。
data "databricks_postgres_endpoints" "dev" {
parent = databricks_postgres_branch.dev.name
}
output "dev_endpoint_names" {
value = [for e in data.databricks_postgres_endpoints.dev.endpoints : e.name]
}
output "dev_endpoint_types" {
value = [
for e in data.databricks_postgres_endpoints.dev.endpoints :
try(e.status.endpoint_type, null)
]
}
構成を適用し、エンドポイントの詳細を表示するには、次のコマンドを実行します。
terraform apply
terraform output dev_endpoint_names
terraform output dev_endpoint_types
terraform applyを実行し、出力のみが変更された場合（インフラストラクチャは変更されません）、Terraform は「出力の変更」を表示し、リソースを変更せずに状態を更新します。
7. ブランチを一覧表示する
プロジェクト内のすべてのブランチを一覧表示します。これにより、プロジェクトで自動的に作成された本番運用ブランチと、前のステップで作成した開発ブランチの 2 つのブランチが返されます。
data "databricks_postgres_branches" "all" {
parent = databricks_postgres_project.app.name
}
output "branch_names" {
value = [for b in data.databricks_postgres_branches.all.branches : b.name]
}
構成を適用し、ブランチ名を表示するには、次のコマンドを実行します。
terraform apply
terraform output branch_names
8. ブランチを削除する
ここで、先ほど作成した開発ブランチを削除します。これは典型的なワークフローです。開発またはテスト用のブランチを作成し、終了したら削除します。
ブランチを削除するときは、関連付けられているエンドポイントをすべて破棄してから、ブランチを破棄します。
8.1 エンドポイントを破壊する
開発ブランチのエンドポイントを破棄します。
terraform destroy -target=databricks_postgres_endpoint.dev_primary
8.2 ブランチを破壊する
開発ブランチを破棄します。
terraform destroy -target=databricks_postgres_branch.dev
8.3 構成から削除
ターゲットを破棄した後、Terraform がリソース ブロックを再作成しないように、構成ファイルからリソース ブロックを削除するかコメント アウトします。
databricks_postgres_branch.devとその出力を削除しますdatabricks_postgres_endpoint.dev_primaryとその出力を削除します- 削除されたブランチを参照するデータソースを更新します (例:
list_endpoints.tf)
次に、状態を調整します。
terraform apply
代替案: すべてを一度に削除する
最初に構成からリソース ブロックを削除してから、 terraform applyを実行することもできます。Terraform はリソースを破棄する予定です。このアプローチでは、実行前に完全な破壊計画が表示されます。