使用 Terraform 部署 PostgreSQL 彈性伺服器資料庫

發行項
04/06/2024

文章使用下列 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 子網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 資料庫

注意

本文中的範例程式碼位於 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>會顯示輸出中terraform apply。<database_name><server_name>

執行 Get-AzPostgreSqlFlexibleServerDatabase 以顯示 Azure PostgreSQL 資料庫。

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

重點︰

、與的值<resource_group_name>會顯示輸出中terraform apply。<database_name><server_name>

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 進行疑難排解

下一步

意見反應

意見反應

其他資源