Terraform Provisioners 與 VMware 基礎架構自動化佈署

Terraform 作為 IaC 工具，能有效簡化基礎架構的管理。Provisioners 功能允許在資源佈署過程中執行指令碼，實作自動化組態。本文除了介紹內嵌 Provisioners 的基本用法，也示範如何利用外部 Provisioners 執行 PowerShell 指令碼，例如將 VMware 虛擬機器加入 Active Directory 網域。過程中，我們會使用 vsphere provider 與 remote-exec、local-exec 等 Provisioner，並搭配變數、資源定義和網路設定等 Terraform 語法。此外，文章也涵蓋了 Terraform 組態檔的備份策略，強調版本控制、自動備份和多重儲存的重要性，確保組態檔的安全性和可靠性。更進一步，我們也討論了 Terraform 如何使用變數、地圖和列表來管理更複雜的組態，例如設定虛擬機器的規格、動態生成組態以及使用預設值等技巧，讓 Terraform 的組態更具彈性、可重複使用，並易於維護。

探索 Terraform Provisioners 在 VMware 基礎架構中的應用

Terraform 是一個強大的基礎架構即程式碼（Infrastructure as Code, IaC）工具，能夠幫助我們自動化基礎架構的建立和管理。在這篇文章中，玄貓將探討 Terraform 的 Provisioners 功能，並展示其在 VMware 基礎架構中的實際應用。

什麼是 Terraform Provisioners

Terraform Provisioners 是一種強大的功能，允許我們在基礎架構佈署過程中，執行指令碼或命令於遠端機器。這些指令碼可以用來進行各種自動化任務，例如組態軟體、安裝依賴項、初始化資料函式庫等。

Terraform 支援兩種型別的 Provisioners：

1. 內嵌 Provisioners：直接在 Terraform 組態檔中定義。
2. 外部 Provisioners：由 Terraform 執行的獨立指令碼或命令。

內嵌 Provisioners 的使用範例

以下是一個使用內嵌 Provisioners 在 VMware 上佈署虛擬機器的範例。我們將在 main.tf 檔案中定義這些組態。

provider "vsphere" {
  user           = var.vsphere_username
  password       = var.vsphere_password
  vsphere_server = var.vsphere_server
  allow_unverified_ssl = true
}

resource "vsphere_virtual_machine" "example_vm" {
  name             = "my-vm"
  resource_pool_id = data.vsphere_resource_pool.pool.id
  datastore_id     = data.vsphere_datastore.datastore.id
  template_uuid    = data.vsphere_virtual_machine.template.id
  num_cpus         = 2
  memory           = 4096

  network_interface {
    network_id = data.vsphere_network.network.id
  }

  provisioner "remote-exec" {
    inline = [
      "echo 'Hello, Provisioner!'",
      "echo 'This is an example of an inline provisioner.'",
      "echo 'You can run custom scripts or commands here.'",
    ]
  }
}

內容解密：

這段程式碼展示瞭如何使用內嵌 Provisioners 在 VMware 上佈署虛擬機器。以下是詳細解說：

1. Provider 組態：我們首先組態了 vsphere 提供者，這個提供者允許我們與 VMware vSphere API 互動。allow_unverified_ssl 被設為 true，以允許連線到未驗證的 SSL 憑證。

2. 資源定義：我們定義了一個 vsphere_virtual_machine 資源，這表示我們將佈署一個新的虛擬機器。這裡包括了虛擬機器的名稱、資源池、資料儲存、範本 UUID、CPU 數量和記憶體大小。

3. 網路介面：我們組態了一個網路介面，並將其連線到指定的網路。

4. 內嵌 Provisioners：我們定義了一個 remote-exec 型別的內嵌 Provisioner，這將在虛擬機器建立後執行一系列命令。這些命令會在新建立的虛擬機器上執行。

外部 Provisioners 的使用範例

外部 Provisioners 較為靈活，允許我們執行自訂指令碼或操作。以下是一個使用外部 Provisioner 在 VMware 上佈署虛擬機器並將其加入 Active Directory 網域的範例。

組態變數和資源

首先，我們需要定義一些變數和資源：

variable "vm_name" {
  type    = string
  default = "my-vm"
}

resource "vsphere_virtual_machine" "my_vm" {
  name          = var.vm_name
  guest_id      = "windows9Server64Guest"
}

組態外部 Provisioner

接下來，我們使用 local-exec 外部 Provisioner 執行一個 PowerShell 指令碼來加入 Active Directory 網域：

resource "null_resource" "configure_vm" {
  triggers = {
    vm_id = vsphere_virtual_machine.my_vm.id
  }

  provisioner "local-exec" {
    command = "powershell -Command \".\\join_domain.ps1\""
  }
}

建立外部指令碼

我們需要建立一個 PowerShell 指令碼 join_domain.ps1，並放置在與 Terraform 組態檔相同的目錄中。這個指令碼包含加入 Active Directory 網域的邏輯：

# PowerShell 指令碼用於將 Windows VM 加入網域
$domain = "example.com"
$username = "admin"
$password = ConvertTo-SecureString "password" -AsPlainText -Force

Add-Computer -DomainName $domain -Credential (New-Object System.Management.Automation.PSCredential ($username, $password))

組態依賴關係

為了確保指令碼在虛擬機器佈署後執行，我們需要設定依賴關係：

depends_on = [vsphere_virtual_machine.my_vm]

應用組態

最後，我們可以應用 Terraform 組態。Terraform 將會佈署 VMware 虛擬機器並執行指令碼以加入 Active Directory 網域。

內容解密：

這段程式碼展示瞭如何使用外部 Provisioner 在 VMware 上佈署虛擬機器並將其加入 Active Directory 網域。以下是詳細解說：

1. 變數定義：我們定義了一個變數 vm_name，用來指定虛擬機器的名稱。

2. 資源定義：我們定義了一個 vsphere_virtual_machine 資源，表示我們將佈署一個新的虛擬機器。這裡包括了虛擬機器的名稱和作業系統 ID。

3. 外部 Provisioner：我們使用 null_resource 和 local-exec 外部 Provisioner 執行一個 PowerShell 指令碼。這個指令碼將會在虛擬機器佈署後執行。

4. PowerShell 指令碼：我們建立了一個 PowerShell 指令碼 join_domain.ps1，用來將虛擬機器加入 Active Directory 網域。

5. 依賴關係：為了確保指令碼在虛擬機器佈署後執行，我們設定了依賴關係。

Terraform 的輸出部分

Terraform 的輸出部分用於定義組態檔生成的輸出值。這些輸出值可以包括資源 ID、IP 地址等資訊，並且可以被其他部分的基礎架構佈署/管理所需。

組態檔備份策略

由於組態檔非常重要，因此需要有一套可靠的備份策略。以下是一些簡單步驟：

• 版本控制：將組態檔存放在版本控制系統中（如 Git）。
• 自動備份：設定自動備份作業，定期備份組態檔。
• 多重儲存：備份組態檔到多個位置（如雲端儲存和本地硬碟）。

使用 Terraform 管理資源

Terraform 是一個強大的基礎設施即程式碼（Infrastructure as Code, IaC）工具，能夠幫助你有效管理和佈署雲端資源。為了確保你的 Terraform 組態檔案能夠被正確備份並且在災難發生時能夠可靠地還原，玄貓建議你遵循以下步驟。

組態檔案備份流程

首先，讓我們來看看如何備份 Terraform 組態檔案：

1. 組態檔案儲存：將你的 Terraform 組態檔案儲存在一個安全且可靠的位置，例如版本控制系統（如 Git）或雲端儲存服務。
2. 敏感資料處理：確保組態檔案中不包含任何敏感資料，例如存取金鑰或密碼。如果必須包含這些資料，請使用加密方式儲存。
3. 定期備份：定期備份你的組態檔案，以防止因為意外事件導致組態檔案丟失。

此圖示展示了備份組態檔案的流程

  graph TD;
    A[組態檔案儲存] --> B[處理敏感資料];
    B --> C[定期備份];

此圖示說明瞭備份 Terraform 組態檔案的基本步驟。首先，將組態檔案儲存在安全的位置，接著處理其中的敏感資料，最後進行定期備份。

變數管理

在使用 Terraform 的過程中，變數是非常重要的一環。變數可以幫助你動態地設定和管理組態檔案中的值，從而使你的基礎設施更加靈活和易於管理。

變數的定義

在你的 Terraform 組態檔案中（通常以 .tf 結尾），你可以使用 variable 塊來宣告變數。例如：

variable "vm_name" {
  description = "Name of the virtual machine"
  type        = string
}

variable "cpu_count" {
  description = "Number of CPUs for the virtual machine"
  type        = number
  default     = 2
}

變數值的指定

變數值可以直接在組態檔案中指定，也可以透過環境變數或命令列引數來指定。這樣可以根據不同的需求和環境來靈活設定變數值。例如：

terraform apply -var "vm_name=web-server" -var "cpu_count=4"

這樣就可以在執行 Terraform 命令時動態設定變數值。

檢証與約束

Terraform 支援對變數進行檢証和約束，這樣可以確保變數值符合特定條件。例如：

variable "cpu_count" {
  description = "Number of CPUs for the virtual machine"
  type        = number
  default     = 2
  validation {
    condition     = var.cpu_count >= 1
    error_message = "The number of CPUs must be at least 1."
  }
}

這樣可以確保 cpu_count 的值至少為1。

模組管理

除了變數之外，Terraform 模組也是非常重要的一部分。模組可以幫助你封裝和重用基礎設施元件，從而簡化組態檔案並減少重複。

模組的使用

模組可以透過版本控制系統（如 Git）來管理和版本化。這樣可以確保模組的完整性和一致性。例如：

module "example" {
  source      = "git::https://github.com/example/module.git//example?ref=v1.0.0"
}

這樣就可以從 Git 儲存函式庫中參照特定版本的模組。

建議與最佳實踐

1. 安全性：確保敏感資料被加密並儲存在安全位置。
2. 版本控制：使用版本控制系統來管理 Terraform 組態檔案和模組。
3. 檢証與約束：對變數進行檢証和約束，以確保其值符合預期。
4. 模組重用：透過模組來封裝和重用基礎設施元件，從而簡化組態檔案並減少重複。

透過以上步驟和建議，玄貓希望能夠幫助你更好地管理和佈署 Terraform 基礎設施。

探討Terraform

在Terraform中，變數是其核心特性之一，可以讓我們的設定更加靈活且可重複使用。讓我們探討如何在Terraform中定義和使用變數、地圖和列表，並藉由具體的VMware案例來進行說明。

使用變數來實作靈活組態

首先，玄貓以定義四個變數為例：vm_name、cpu_count、memory_size以及disk_size。每個變數都有詳細的描述，說明其用途。以下是這些變數的定義：

variable "vm_name" {
  description = "Name of the virtual machine"
  type        = string
  default     = "example-vm"
}

variable "cpu_count" {
  description = "Number of CPUs for the virtual machine"
  type        = number
  default     = 2
}

variable "memory_size" {
  description = "Amount of memory in MB for the virtual machine"
  type        = number
  default     = 4096
}

variable "disk_size" {
  description = "Size of the virtual disk in GB"
  type        = number
  default     = 20
}

內容解密：

• variable 命令用來定義Terraform的變數。
• description 用來描述變數的用途，增加可讀性和維護性。
• type 指定變數的資料型態，這裡使用了 string 和 number。
• default 提供預設值，當執行Terraform命令時沒有提供值時會使用這些預設值。

在vsphere_virtual_machine資源區塊中，我們使用var前置詞來參照這些變數：

resource "vsphere_virtual_machine" "example_vm" {
  name     = var.vm_name
  cpu_number = var.cpu_count
  memory   = var.memory_size
  # ... 其他組態選項
}

概念解說：

• var前置詞用來參照已定義的變數。
• 在組態檔案中動態地將值引入，這樣可以根據需求靈活調整。

例如，執行以下命令時：

terraform plan -var="vm_name=web-server" -var="cpu_count=4"

這樣就可以覆寫vm_name變數為web-server，並將cpu_count變數設定為4。這種方式使得我們能夠根據具體需求來定製虛擬機器的屬性，從而提高Terraform組態的靈活性和可重複使用性。

地圖（Maps）

地圖在Terraform中允許我們定義一組鍵值對，每個鍵都是唯一的。地圖有助於以結構化的方式組織和管理資料。以下是如何在Terraform中的VMware組態中使用地圖：

variable "vm_config" {
  description = "Configuration details of VMware virtual machines"
  type        = map(any)
}

variable "vm_config" {
    default = {
        web-server = {
            cpu_count    = 2
            memory_size  = 4096
            disk_size    = 20
        }
        database-server = {
            cpu_count    = 4
            memory_size  = 8192
            disk_size    = 100
        }
    }
}

概念解說：

• 地圖允許我們以鍵值對的方式儲存資料，每個鍵都是唯一的。
• type 必須為 map 或 map(any)，用來表示這是一個地圖型別。
• 在地圖中可以直接設定預設值。

在資源區塊中存取地圖中的值：

resource "vsphere_virtual_machine" "example_vm" {
    name         = "web-server"
    cpu_number   = var.vm_config["web-server"]["cpu_count"]
    memory       = var.vm_config["web-server"]["memory_size"]
    disk_size    = var.vm_config["web-server"]["disk_size"]
    # ... 其他組態選項
}

概念解說：

• 用鍵來存取地圖中的特定值。
• 地圖允許我們以更結構化和有組織的方式管理多台虛擬機器的組態。

此外，我們還可以動態地填充地圖。例如，可以使用迴圈遍歷列表並根據特定條件生成地圖：

locals {
    vm_list   = ["web-server", "database-server"]
    vm_configs= { for name in local.vm_list: name => {"cpu_count": length(name) * 2, "memory_size": length(name) * 512, "disk_size": length(name) * 10} }
}

概念解說：

• locals 命令用來定義本地值。
• for 語法用來動態生成地圖中的鍵值對。

預設值（Variable Defaults）

在Terraform中我們可以為變數設定預設值，確保即讓使用者沒有明確提供值時也能正常執行。例如：

variable "vm_cpu_count" {
    description   ="Number of CPUs for virtual machine"
    type          ="number"
    default       ="2"
}

概念解說：

• default 用來設定預設值。
• 在沒有提供特定值時使用預設值。

在資源區塊中參照這個預設值：

resource "vsphere_virtual_machine" "example_vm" {
    name         ="web-server"
    cpu_count    ="var.vm_cpu_count"
    # ... 其他組態選項
}

概念解說：

• var.vm_cpu_count 用來參照預設變數。

如果需要覆寫預設值，可以在執行時明確提供新值：

terraform plan -var="vm_cpu_count=4"

填充變數（Populating Variables）

我們可以透過多種方式填充Terraform中的變數。以下是一些常見方法：

1. 命令列引數：直接在命令列中提供引數。
2. 環境變數：將變數儲存在環境變數中。
3. 檔案：從 .tfvars 檔案或外部檔案中載入。

例如：命令列引數

terraform apply -var="vm_name=prod-web-server"

例如：環境變數

export TF_VAR_vm_name="prod-web-server"
terraform apply

例如：檔案

# vars.tfvars
vm_name      ="prod-web-server"

terraform apply -var-file="vars.tfvars"

概念解說：

• 命令列引數和環境變數都可以直接覆寫或提供新值給變數。
• .tfvars 檔案是更結構化且易於維護的方式來管理多個引數。

總結來說，透過精巧設計Terraform中的變數、地圖和列表，我們能夠大大提升組態檔案的靈活性與可重複使用性。同時還能夠避免硬編碼價值帶來的維護困難。