Terraform を使用して PostgreSQL フレキシブルサーバーデータベースをデプロイする

[アーティクル]
10/26/2023

次の Terraform と Terraform プロバイダーのバージョンでテストされた記事:

Terraform を使用すると、クラウドインフラストラクチャの定義、プレビュー、およびデプロイを行うことができます。 Terraform を使用する際は、HCL 構文を使って構成ファイルを作成します。 HCL 構文では、Azure などのクラウドプロバイダーと、クラウドインフラストラクチャを構成する要素を指定できます。構成ファイルを作成したら、"実行プラン" を作成します。これにより、インフラストラクチャの変更をデプロイ前にプレビューすることができます。変更を確認したら、実行プランを適用してインフラストラクチャをデプロイします。

この記事では、Terraform を使用して PostgreSQL フレキシブルサーバーデータベースをデプロイする方法について説明します。

この記事では、次のことについて説明します。

azurerm_resource_group を使用して Azure リソースグループを作成する
azurerm_virtual_network を使用して Azure 仮想ネットワーク (VNet) を作成する
azurerm_network_security_group を使用して Azure ネットワークセキュリティグループ (NSG) を作成する
Azure の subnet azurerm_subnet を作成する
azurerm_subnet_network_security_group_association を使用して Azure サブネットネットワークセキュリティグループ (NSG) を作成する
azurerm_private_dns_zone を使用して Azure DNS 内にプライベート DNS ゾーンを定義する
azurerm_private_dns_zone_virtual_network_link を使用してプライベート DNS ゾーン VNet リンクを定義する
azurerm_postgresql_flexible_server を使用して、データベースを実行する Azure PostgreSQL フレキシブルサーバーをデプロイする
azurerm_postgresql_flexible_server_database を使用して Azure PostgreSQL データベースインスタンスを作成する

Note

この記事のコード例は、Azure Terraform GitHub リポジトリにあります。

1. 環境を構成する

Azure サブスクリプション:Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

Terraform の構成: まだ行っていない場合は、次のいずれかのオプションを使用して Terraform を構成します。

2. Terraform コードを実装する

サンプル Terraform コードをテストして実行するディレクトリを作成し、それを現在のディレクトリにします。

providers.tf という名前のファイルを作成し、次のコードを挿入します。

terraform {
  required_version = ">=1.0"

  required_providers {
    azurerm = {
      source  = "hashicorp/azurerm"
      version = "~>3.0"
    }
    random = {
      source  = "hashicorp/random"
      version = ">= 3.4.0"
    }
  }
}

provider "azurerm" {
  features {}
}

main.tf という名前のファイルを作成し、次のコードを挿入して、データベースを実行する PostgreSQL フレキシブルサーバーをデプロイします。

resource "random_pet" "name_prefix" {
  prefix = var.name_prefix
  length = 1
}

resource "azurerm_resource_group" "default" {
  name     = random_pet.name_prefix.id
  location = var.location
}

resource "azurerm_virtual_network" "default" {
  name                = "${random_pet.name_prefix.id}-vnet"
  location            = azurerm_resource_group.default.location
  resource_group_name = azurerm_resource_group.default.name
  address_space       = ["10.0.0.0/16"]
}

resource "azurerm_network_security_group" "default" {
  name                = "${random_pet.name_prefix.id}-nsg"
  location            = azurerm_resource_group.default.location
  resource_group_name = azurerm_resource_group.default.name

  security_rule {
    name                       = "test123"
    priority                   = 100
    direction                  = "Inbound"
    access                     = "Allow"
    protocol                   = "Tcp"
    source_port_range          = "*"
    destination_port_range     = "*"
    source_address_prefix      = "*"
    destination_address_prefix = "*"
  }
}

resource "azurerm_subnet" "default" {
  name                 = "${random_pet.name_prefix.id}-subnet"
  virtual_network_name = azurerm_virtual_network.default.name
  resource_group_name  = azurerm_resource_group.default.name
  address_prefixes     = ["10.0.2.0/24"]
  service_endpoints    = ["Microsoft.Storage"]

  delegation {
    name = "fs"

    service_delegation {
      name = "Microsoft.DBforPostgreSQL/flexibleServers"

      actions = [
        "Microsoft.Network/virtualNetworks/subnets/join/action",
      ]
    }
  }
}

resource "azurerm_subnet_network_security_group_association" "default" {
  subnet_id                 = azurerm_subnet.default.id
  network_security_group_id = azurerm_network_security_group.default.id
}

resource "azurerm_private_dns_zone" "default" {
  name                = "${random_pet.name_prefix.id}-pdz.postgres.database.azure.com"
  resource_group_name = azurerm_resource_group.default.name

  depends_on = [azurerm_subnet_network_security_group_association.default]
}

resource "azurerm_private_dns_zone_virtual_network_link" "default" {
  name                  = "${random_pet.name_prefix.id}-pdzvnetlink.com"
  private_dns_zone_name = azurerm_private_dns_zone.default.name
  virtual_network_id    = azurerm_virtual_network.default.id
  resource_group_name   = azurerm_resource_group.default.name
}

resource "random_password" "pass" {
  length = 20
}

resource "azurerm_postgresql_flexible_server" "default" {
  name                   = "${random_pet.name_prefix.id}-server"
  resource_group_name    = azurerm_resource_group.default.name
  location               = azurerm_resource_group.default.location
  version                = "13"
  delegated_subnet_id    = azurerm_subnet.default.id
  private_dns_zone_id    = azurerm_private_dns_zone.default.id
  administrator_login    = "adminTerraform"
  administrator_password = random_password.pass.result
  zone                   = "1"
  storage_mb             = 32768
  sku_name               = "GP_Standard_D2s_v3"
  backup_retention_days  = 7

  depends_on = [azurerm_private_dns_zone_virtual_network_link.default]
}

postgresql-fs-db.tf という名前のファイルを作成し、次のコードを挿入して、データベースインスタンスを作成します。

resource "azurerm_postgresql_flexible_server_database" "default" {
  name      = "${random_pet.name_prefix.id}-db"
  server_id = azurerm_postgresql_flexible_server.default.id
  collation = "en_US.utf8"
  charset   = "UTF8"
}

variables.tf という名前のファイルを作成し、次のコードを挿入します。

variable "name_prefix" {
  default     = "postgresqlfs"
  description = "Prefix of the resource name."
}

variable "location" {
  default     = "eastus"
  description = "Location of the resource."
}

outputs.tf という名前のファイルを作成し、次のコードを挿入して、リソースグループ名、Azure PostgreSQL サーバー名、および Azure PostgreSQL データベース名を出力します。

output "resource_group_name" {
  value = azurerm_resource_group.default.name
}

output "azurerm_postgresql_flexible_server" {
  value = azurerm_postgresql_flexible_server.default.name
}

output "postgresql_flexible_server_database_name" {
  value = azurerm_postgresql_flexible_server_database.default.name
}

output "postgresql_flexible_server_admin_password" {
  sensitive = true
  value     = azurerm_postgresql_flexible_server.default.administrator_password
}

3. Terraform を初期化する

terraform init を実行して、Terraform のデプロイを初期化します。このコマンドによって、Azure リソースを管理するために必要な Azure プロバイダーがダウンロードされます。

terraform init -upgrade

重要なポイント:

-upgrade パラメーターは、必要なプロバイダープラグインを、構成のバージョン制約に準拠する最新バージョンにアップグレードします。

4. Terraform 実行プランを作成する

terraform plan を実行して、実行プランを作成します。

terraform plan -out main.tfplan

重要なポイント:

terraform plan コマンドは、実行プランを作成しますが、実行はしません。代わりに、構成ファイルに指定された構成を作成するために必要なアクションを決定します。このパターンを使用すると、実際のリソースに変更を加える前に、実行プランが自分の想定と一致しているかどうかを確認できます。
省略可能な -out パラメーターを使用すると、プランの出力ファイルを指定できます。 -out パラメーターを使用すると、レビューしたプランが適用内容とまったく同じであることが確実になります。
実行プランの永続化とセキュリティの詳細については、「セキュリティの警告」セクションを参照してください。

5. Terraform 実行プランを適用する

terraform apply を実行して、クラウドインフラストラクチャに実行プランを適用します。

terraform apply main.tfplan

重要なポイント:

terraform apply コマンドの例は、以前に terraform plan -out main.tfplan が実行されたことを前提としています。
-out パラメーターに別のファイル名を指定した場合は、terraform apply の呼び出しで同じファイル名を使用します。
-out パラメーターを使用しなかった場合は、パラメーターを指定せずに terraform apply を呼び出します。

az postgres flexible-server db show を実行して、Azure PostgreSQL データベースを表示します。

az postgres flexible-server db show --resource-group <resource_group_name> --server-name <server_name> --database-name <database_name>

重要なポイント:

<resource_group_name>、<server_name>、および <database_name> の値が terraform apply 出力に表示されます。

Get-AzPostgreSqlFlexibleServerDatabase を実行して、Azure PostgreSQL データベースを表示します。

Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName <resource_group_name> -ServerName <server_name> -Name <database_name>

重要なポイント:

<resource_group_name>、<server_name>、および <database_name> の値が terraform apply 出力に表示されます。

7.リソースをクリーンアップする

Terraform を使用して作成したリソースが不要になった場合は、次の手順を実行します。

terraform plan を実行して、destroy フラグを指定します。
```
terraform plan -destroy -out main.destroy.tfplan
```
重要なポイント:
- terraform plan コマンドは、実行プランを作成しますが、実行はしません。代わりに、構成ファイルに指定された構成を作成するために必要なアクションを決定します。このパターンを使用すると、実際のリソースに変更を加える前に、実行プランが自分の想定と一致しているかどうかを確認できます。
- 省略可能な -out パラメーターを使用すると、プランの出力ファイルを指定できます。 -out パラメーターを使用すると、レビューしたプランが適用内容とまったく同じであることが確実になります。
- 実行プランの永続化とセキュリティの詳細については、「セキュリティの警告」セクションを参照してください。
terraform apply を実行して、実行プランを適用します。
```
terraform apply main.destroy.tfplan
```

Azure での Terraform のトラブルシューティング

Azure で Terraform を使用する場合の一般的な問題のトラブルシューティング

次のステップ

PostgreSQL フレキシブルサーバーの詳細を確認する

Terraform を使用して PostgreSQL フレキシブルサーバーデータベースをデプロイする

1. 環境を構成する

2. Terraform コードを実装する

3. Terraform を初期化する

4. Terraform 実行プランを作成する

5. Terraform 実行プランを適用する

6. 結果を確認する

7.リソースをクリーンアップする

Azure での Terraform のトラブルシューティング

次のステップ

フィードバック

フィードバック

その他のリソース

Terraform を使用して PostgreSQL フレキシブル サーバー データベースをデプロイする

1. 環境を構成する

2. Terraform コードを実装する

3. Terraform を初期化する

4. Terraform 実行プランを作成する

5. Terraform 実行プランを適用する

6. 結果を確認する

7.リソースをクリーンアップする

Azure での Terraform のトラブルシューティング

次のステップ

フィードバック

フィードバック

その他のリソース

Terraform を使用して PostgreSQL フレキシブルサーバーデータベースをデプロイする