クイックスタート: Terraform を使用して Azure Database for MySQL - フレキシブルサーバーのインスタンスを作成する

[アーティクル]
04/07/2024

適用対象: Azure Database for MySQL - フレキシブルサーバー

このクイックスタートは、次の Terraform と Terraform プロバイダーのバージョンを使用してテストされています。

Azure Database for MySQL - フレキシブルサーバーは、高可用性の MySQL データベースをクラウド内で実行、管理、スケーリングするために使用されるマネージドサービスです。 Azure Resource Manager テンプレート (ARM テンプレート) を使用すると、複数のサーバーをデプロイ、または 1 つのサーバー上にある複数のデータベースをデプロイするための Azure Database for MySQL - フレキシブルサーバーをプロビジョニングできます。

この記事では、Terraform を使用して、仮想ネットワークに Azure Database for MySQL - フレキシブルサーバーのインスタンスおよびデータベースをデプロイする方法について説明します。

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

azurerm_resource_group を使用して Azure リソースグループを作成する。
azurerm_virtual_network を使用して Azure 仮想ネットワークを作成する。
azurerm_subnet を使用して Azure サブネットを作成する。
azurerm_private_dns_zone を使用して Azure DNS のインスタンス内にプライベート DNS ゾーンを定義する。
azurerm_private_dns_zone_virtual_network_link を使用してプライベート DNS ゾーン仮想ネットワークリンクを定義する。
azurerm_mysql_flexible_server を使用して Azure Database for MySQL - フレキシブルサーバーをデプロイする。
azurerm_mysql_flexible_database を使用してデータベースをデプロイする。

Note

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

前提条件

Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。現在、Azure 無料アカウントがあれば、Azure Database for MySQL - フレキシブルサーバーを 12 か月間無料でお試しいただけます。詳細については、Azure Database for MySQL - フレキシブルサーバーの無料トライアルに関するページを参照してください。
Terraform のインストールと構成

Terraform コードを実装する

サンプルの Terraform コードのテストに使用できるディレクトリを作成します。その Terraform ディレクトリを現在のディレクトリにします。

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

terraform {
  required_version = ">=1.0"

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

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

provider "azurerm" {
  features {}
}

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

# Generate random resource group name
resource "random_pet" "rg_name" {
  prefix = var.resource_group_name_prefix
}

resource "azurerm_resource_group" "rg" {
  location = var.resource_group_location
  name     = random_pet.rg_name.id
}

# Generate random value for the name
resource "random_string" "name" {
  length  = 8
  lower   = true
  numeric = false
  special = false
  upper   = false
}

# Generate random value for the login password
resource "random_password" "password" {
  length           = 8
  lower            = true
  min_lower        = 1
  min_numeric      = 1
  min_special      = 1
  min_upper        = 1
  numeric          = true
  override_special = "_"
  special          = true
  upper            = true
}

# Manages the Virtual Network
resource "azurerm_virtual_network" "default" {
  address_space       = ["10.0.0.0/16"]
  location            = azurerm_resource_group.rg.location
  name                = "vnet-${random_string.name.result}"
  resource_group_name = azurerm_resource_group.rg.name
}

# Manages the Subnet
resource "azurerm_subnet" "default" {
  address_prefixes     = ["10.0.2.0/24"]
  name                 = "subnet-${random_string.name.result}"
  resource_group_name  = azurerm_resource_group.rg.name
  virtual_network_name = azurerm_virtual_network.default.name
  service_endpoints    = ["Microsoft.Storage"]

  delegation {
    name = "fs"

    service_delegation {
      name = "Microsoft.DBforMySQL/flexibleServers"
      actions = [
        "Microsoft.Network/virtualNetworks/subnets/join/action",
      ]
    }
  }
}

# Enables you to manage Private DNS zones within Azure DNS
resource "azurerm_private_dns_zone" "default" {
  name                = "${random_string.name.result}.mysql.database.azure.com"
  resource_group_name = azurerm_resource_group.rg.name
}

# Enables you to manage Private DNS zone Virtual Network Links
resource "azurerm_private_dns_zone_virtual_network_link" "default" {
  name                  = "mysqlfsVnetZone${random_string.name.result}.com"
  private_dns_zone_name = azurerm_private_dns_zone.default.name
  resource_group_name   = azurerm_resource_group.rg.name
  virtual_network_id    = azurerm_virtual_network.default.id

  depends_on = [azurerm_subnet.default]
}

# Manages the MySQL Flexible Server
resource "azurerm_mysql_flexible_server" "default" {
  location                     = azurerm_resource_group.rg.location
  name                         = "mysqlfs-${random_string.name.result}"
  resource_group_name          = azurerm_resource_group.rg.name
  administrator_login          = random_string.name.result
  administrator_password       = random_password.password.result
  backup_retention_days        = 7
  delegated_subnet_id          = azurerm_subnet.default.id
  geo_redundant_backup_enabled = false
  private_dns_zone_id          = azurerm_private_dns_zone.default.id
  sku_name                     = "GP_Standard_D2ds_v4"
  version                      = "8.0.21"

  high_availability {
    mode                      = "SameZone"
  }
  maintenance_window {
    day_of_week  = 0
    start_hour   = 8
    start_minute = 0
  }
  storage {
    iops    = 360
    size_gb = 20
  }

  depends_on = [azurerm_private_dns_zone_virtual_network_link.default]
}

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

# Manages the MySQL Flexible Server Database
resource "azurerm_mysql_flexible_database" "main" {
  charset             = "utf8mb4"
  collation           = "utf8mb4_unicode_ci"
  name                = "mysqlfsdb_${random_string.name.result}"
  resource_group_name = azurerm_resource_group.rg.name
  server_name         = azurerm_mysql_flexible_server.default.name
}

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

variable "resource_group_location" {
  type        = string
  default     = "westeurope"
  description = "Location of the resource group."
}

variable "resource_group_name_prefix" {
  type        = string
  default     = "mysql-fs-db-rg"
  description = "Prefix of the resource group name that's combined with a random ID so name is unique in your Azure subscription."
}

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

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

output "admin_login" {
  value = azurerm_mysql_flexible_server.default.administrator_login
}

output "admin_password" {
  sensitive = true
  value     = azurerm_mysql_flexible_server.default.administrator_password
}

output "mysql_flexible_server_database_name" {
  value = azurerm_mysql_flexible_database.main.name
}

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

Terraform を初期化する

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

terraform init -upgrade

重要なポイント:

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

Terraform 実行プランを作成する

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

terraform plan -out main.tfplan

重要なポイント:

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

Terraform 実行プランを適用する

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

terraform apply main.tfplan

重要なポイント:

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

Azure Database for MySQL - フレキシブルサーバーデータベースを表示するには、az mysql flexible-server db show を実行します。

az mysql flexible-server db show \
    --resource-group <resource_group_name> \
    --server-name <azurerm_mysql_flexible_server> \
    --database-name <mysql_flexible_server_database_name>

次の "重要なポイント" を考慮してください。

<resource_group_name>、<azurerm_mysql_flexible_server>、<mysql_flexible_server_database_name> の値が terraform apply の出力に表示されます。また、terraform output コマンドを実行して、これらの値を表示することもできます。

Azure Database for MySQL フレキシブルサーバーデータベースを表示するには、Get-AzMySqlFlexibleServerDatabase を実行します。

Get-AzMySqlFlexibleServerDatabase `
    -ResourceGroupName <resource_group_name> `
    -ServerName <azurerm_mysql_flexible_server> `
    -Name <mysql_flexible_server_database_name>

次の "重要なポイント" を考慮してください。

<resource_group_name>、<azurerm_mysql_flexible_server>、および <mysql_flexible_server_database_name> の値が terraform apply 出力に表示されます。また、terraform output コマンドを実行して、これらの出力値を表示することもできます。

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

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 を使用する場合の一般的な問題のトラブルシューティングを行う方法を確認します。

次のステップ

プライベートアクセスを使用して Azure Database for MySQL - フレキシブルサーバーのインスタンスに接続する

クイックスタート: Terraform を使用して Azure Database for MySQL - フレキシブル サーバーのインスタンスを作成する

前提条件

Terraform コードを実装する

Terraform を初期化する

Terraform 実行プランを作成する

Terraform 実行プランを適用する

結果を確認する

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

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

次のステップ

その他のリソース

クイックスタート: Terraform を使用して Azure Database for MySQL - フレキシブルサーバーのインスタンスを作成する