在現今的 DevOps 實務中，基礎設施即程式碼 (IaC) 已成為不可或缺的一環。Terraform 作為 IaC 的主流工具，搭配 vSphere 虛擬化平台，能有效管理複雜的雲端環境。本文將示範如何以 Python 程式碼，自動產生適用於 vSphere 環境的 Terraform 組態檔，大幅簡化佈署流程並確保設定一致性。此方法的核心概念是利用 Python 的程式化能力，讀取 vSphere 環境的相關資訊，例如虛擬機器的規格、網路設定、資源池和資料儲存等，再將這些資訊轉換成 Terraform 可讀取的 JSON 格式組態檔。透過這種方式，我們可以避免繁瑣的手動設定，減少人為錯誤，並提升佈署效率。程式碼中，我們會使用 Python 內建的 json 模組來處理 JSON 資料，並使用 OrderedDict 來確保 JSON 物件的鍵值順序，以維持組態檔的可讀性和一致性。此外，程式碼也示範瞭如何處理虛擬機器的網路介面、磁碟設定等細節，並將這些資訊整合到 Terraform 組態檔中。
透過 Python 自動化生成 vSphere 環境的 Terraform 組態檔
在現代雲端運算和自動化管理中，vSphere 是一個廣泛使用的虛擬化平台。利用 Python 來自動生成 Terraform 組態檔，可以大大提升 vSphere 環境的佈署效率和一致性。本文將探討如何利用 Python 來生成 Terraform 組態檔，並詳細解說每個步驟及其背後的技術原理。
概述
Terraform 是一個開源的基礎設施即程式碼（Infrastructure as Code, IaC）工具，能夠讓使用者使用簡單的語法來描述和管理雲端資源。vSphere 是 VMware 提供的虛擬化平台，提供強大的資源管理和虛擬機器佈署功能。將這兩者結合，可以實作高效、可重複的 vSphere 環境佈署。
主要步驟
- 準備環境：確保已安裝 Python 和必要的套件。
- 讀取 vSphere 資訊：從 vSphere API 或組態檔中讀取虛擬機器和網路資訊。
- 生成 Terraform 組態檔：根據讀取到的資訊，生成 Terraform 的 JSON 組態檔。
程式碼範例
以下是一段完整的 Python 程式碼範例，展示如何從 vSphere 資訊中生成 Terraform 組態檔。
import json
import re
from collections import OrderedDict
# 假設 vm_config, vm_network, vm_parent, network_adapter 等變數已經定義好
data = {
"provider": {
"vsphere": {
"vsphere_server": "XX.XX.XX.XX",
"user": "administrator@vsphere.local",
"password": "xxxxxx",
"allow_unverified_ssl": "true"
}
},
"data": {},
"resource": {
"vsphere_virtual_machine": {
"jsontemplate": {}
}
}
}
# 處理網路資訊
for index, nic in reversed(list(enumerate(vm_network))):
network_string = str(nic.name)
data["data"]["vsphere_network" + str(index)] = OrderedDict()
data["data"]["vsphere_network" + str(index)]["network" + str(index)] = OrderedDict()
data["data"]["vsphere_network" + str(index)]["network" + str(index)]["name"] = network_string
data["data"]["vsphere_network" + str(index)]["network" + str(index)]["datacenter_id"] = "${data.vsphere_datacenter.dc.id}"
# 處理網路介面細節
for index, nic in reversed(list(enumerate(vm_network))):
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["network_interface" + str(index)] = {
"adapter_type": network_adapter.pop()
}
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["network_interface" + str(index)]["network_id"] = str("${data.vsphere_network.network" + str(index) + ".id}")
# 處理虛擬機器基本資訊
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["name"] = str(vm_config.name)
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["folder"] = vm_parent.name
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["resource_pool_id"] = "${data.vsphere_resource_pool.pool.id}"
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["datastore_id"] = "${data.vsphere_datastore.datastore.id}"
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["boot_retry_enabled"] = vm_config.bootOptions.bootRetryEnabled
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["enable_disk_uuid"] = vm_config.flags.diskUuidEnabled
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["enable_logging"] = vm_config.flags.enableLogging
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["num_cores_per_socket"] = vm_config.hardware.numCoresPerSocket
data["resource"]["vsphere_virtual_machine"]["jsontemplate"]["num_cpus"] = vm_config.hardware.numCPU
data["resource"]["vsphere_virtual_machine"]["jsontemplate]["guest_id"] = str(vm_config.guestId)
data["resource"]["vsphere_virtual_machine]["jsontemplate]["memory"] = vm_config.hardware.memoryMB
#### 內容解密：
- 這段程式碼首先定義了一個基本的 `data` 資料結構，包含 `provider` 和 `resource` 段落。
- 接著遍歷 `vm_network` 列表，將每個網路介面的名稱和資料中心 ID 新增到 `data` 中。
- 然後遍歷 `vm_network` 列表，將每個網路介面的介面卡型別和網路 ID 新增到 `jsontemplate` 中。
- 最後，將虛擬機器的基本資訊（如名稱、資源池 ID、資料儲存 ID 等）新增到 `jsontemplate` 中。
```python
# 處理其他虛擬機器詳細資訊
data["resource"]["vsphere_virtual_machine]["jsontemplate]["cpu_hot_add_enabled"] = str(vm_config.cpuHotAddEnable).lower()
data["resource]["vsphere_virtual_machine]["jsontemplate]["memory_hot_add_enabled"] = str(vm_config.memoryHotAddEnabled).lower()
data["resource]["vsphere_virtual_machine]["jsontemplate]["firmware"] = str(vm_config.firmware).lower()
data["resource]["vsphere_virtual_machine]["jsontemplate]["scsi_type"] = "${data.vsphere_virtual_machine.template.scsi_type}"
data["resource]["vsphere_virtual_machine]["jsontemplate]["lifecycle"] = { "ignore_changes": ["custom_attributes", "tags"]}
# 處理磁碟資訊
disk_starting_name = "disk"
no_of_disk = 0
for item_virtualdisk in vm_config.hardware.device:
if isinstance(item_virtualdisk, type):
diskname = disk_starting_name + str(no_of_disk)
data["resource"][“vsphere_virtual_machine”][“jsontemplate”][diskname] = OrderedDict()
data["resource"][“vsphere_virtual_machine”][“jsontemplate”][diskname][“label”] = f"disk{item_virtualdisk.unitNumber}"
data["resource"][“vsphere_virtual_machine”][“jsontemplate”][diskname][“size”] = int(item_virtualdisk.capacityInKB / 1048576)
data[“resource”][“vsphere_virtual_machine”][“jsontemplate”][diskname][“unit_number”] = item_virtualdisk.unitNumber
data[“resource”][“vsphere_virtual_machine”][“jsontemplate”][diskname][“thin_provisioned”] = str(item_virtualdisk.backing.thinProvisioned).lower()
data[“resource”][“vsphere_virtual_machine”][“jsontemplate”][diskname][“path”] = item_virtualdisk.backing.fileName
data[“resource”][“vsphere_virtual_machine”][“jsontemplate”][diskname][“keep_on_remove”] = “true”
no_of_disk += 1
# 處理 JSON 資料並生成組態檔
for key in data:
if key == 'resource':
for t in data[key]:
if t == 'vsphere_virtual_machine':
data[key][t].pop('jsontemplate')
json_string = json.dumps(data, indent=4)
# 調整磁碟名稱和網路名稱
for i in range(no_of_disk):
replace_string = f'"disk{i}": {{'
json_string = re.sub(replace_string, '"disk": {', json_string)
for i in range(len(vm_network)):
replace_string1 = f'"network_interface{i}": {{'
replace_string2= f'"network{i}": {{'
json_string1= re.sub(replace_string1, '"network_interface": {', json_string)
json_string2= re.sub(replace_string2, '"network": {', json_string1)
with open("main.tf.json", "w") as outfile:
outfile.write(json_string)
內容解密：
- 接著處理了虛擬機器的其他詳細資訊，如 CPU 和記憶體熱新增功能、韌體型別和 SCSI 型別等。
- 對於每個虛擬磁碟，程式碼會遍歷
vm_config.hardware.device，並將磁碟的標籤、大小、單元號、薄組態狀態和路徑等資訊新增到jsontemplate中。 - 最終處理 JSON 資料並生成組態檔，調整磁碟名稱和網路名稱，確保組態檔符合 Terraform 的要求。
- 一些須要注意的是為了讓 JSON 的排序固定，且不會有連續字串定義出問題。因此需要進行正規表示式替換。如果有其他方法能夠避免這個問題也可以考慮使用。
自動化的優勢
透過上述程式碼，玄貓成功地實作了從 vSphere 資訊自動生成 Terraform 組態檔的功能。這種自動化方法具有以下幾個優勢：
- 提高效率：減少手動組態的工作量，提升佈署速度。
- 一致性：確保每次佈署都使用相同的組態，減少人為錯誤。
- 可重複性：可以輕鬆重複佈署相同的環境，適合於開發、測試和生產環境之間的切換。
- 可維護性：組態檔由程式碼生成，易於維護和更新。
未來趨勢
隨著雲端運算和自動化技術的不斷發展，玄貓認為未來將會有更多類別似的工具和框架出現，進一步簡化基礎設施管理。例如：
- 更多支援更多雲平台：除了 vSphere 外，未來可能會有更多雲平台（如 AWS、Azure）支援這種自動化方法。
- 智慧化組態：利用 AI 和機器學習技術，自動最佳化組態引數，進一步提升效率。
- 整合 DevOps 工具鏈：與 CI/CD 工具鏈整合，實作完全自動化的佈署流程。
