透過 Vagrant CLI 與腳本實現開發環境自動化

在現代軟體開發流程中，確保開發環境的一致性與可重複性至關重要。Vagrant 作為基礎設施即程式碼（Infrastructure as Code）工具，允許開發者透過一份設定檔（Vagrantfile）定義並管理虛擬化環境。本文將探討如何運用 Vagrant 命令列介面（CLI）與配置腳本，從初始化虛擬機、自動安裝 Ansible 等工具，到設定共享目錄，完整建構一個標準化工作區，有效解決因環境差異造成的協作問題。

本地開發環境的自動化：Vagrant CLI 操作與腳本配置

在完成 Vagrantfile 的基本結構創建後，接下來的步驟是利用 Vagrant 的命令列介面 (CLI) 來初始化、創建並配置本地虛擬機。這包括生成基礎的 Vagrantfile，編寫實際的配置腳本，以及將這些配置應用到虛擬機上。

初始化 Vagrant 環境與創建 `Vagrantfile`

創建專用目錄: 首先，在您的專案中創建一個專門用於存放 Vagrant 配置的目錄，例如 Vagrantfiles。
初始化 Vagrant: 在該目錄下打開終端機，執行 vagrant init 命令，並指定您想要使用的基礎映像 (Box) 名稱。
```
vagrant init ubuntu/bionic64
```
此命令會在當前目錄下生成一個名為 Vagrantfile 的文件。這個文件包含了預設的配置，其中最基本的一項就是指定了 config.vm.box = "ubuntu/bionic64"，表明將使用 Ubuntu Bionic 64 位元的映像作為基礎。

編寫配置腳本與更新 `Vagrantfile`

為了實現虛擬機的自動化配置，我們需要編寫腳本並在 Vagrantfile 中引用它們。

創建腳本目錄與腳本文件: 在 Vagrantfiles 目錄內，創建一個名為 scripts 的子目錄。然後，在此 scripts 目錄中創建一個名為 ansible.sh 的 shell 腳本文件，並填入以下內容，用於安裝 Ansible：
```
#!/bin/bash
apt-get update
sudo apt-get --assume-yes install software-properties-common
sudo apt-add-repository --yes --update ppa:ansible/ansible
sudo apt-get --assume-yes install ansible
```
這個腳本會更新套件列表，安裝必要的依賴，添加 Ansible 的 PPA (Personal Package Archive)，最後安裝 Ansible。
更新 Vagrantfile 以引用腳本: 打開先前生成的 Vagrantfile 文件，並在其中添加或修改以下配置，以指定使用我們創建的 ansible.sh 腳本進行配置：
```
Vagrant.configure("2") do |config|
  config.vm.box = "ubuntu/bionic64"

  # 使用 shell 配置器執行腳本
  config.vm.provision "shell", path: "scripts/ansible.sh"

  # ... 其他配置
end
```
config.vm.provision "shell", path: "scripts/ansible.sh" 這行指令告訴 Vagrant，在虛擬機啟動並配置過程中，執行位於 scripts/ansible.sh 路徑的腳本。

配置本地目錄共享

為了方便開發，我們通常需要將本地開發目錄與虛擬機內的目錄進行同步。這樣，您可以在本地編輯程式碼，而這些變更會即時反映在虛擬機中。

更新 Vagrantfile 以配置共享文件夾:

在 Vagrantfile 中添加 config.vm.synced_folder 指令來實現目錄共享。

Vagrant.configure("2") do |config|
  config.vm.box = "ubuntu/bionic64"
  config.vm.provision "shell", path: "scripts/ansible.sh"

  # 配置共享文件夾
  # 將本地的 "C:\\<path>\\CHAP03\\devopsansible" 目錄同步到虛擬機的 "/learningdevops" 目錄
  config.vm.synced_folder "C:\\<path>\\CHAP03\\devopsansible", "/learningdevops"

  # ... 其他配置
end

請注意，您需要將 "C:\\<path>\\CHAP03\\devopsansible" 替換為您本地實際的目錄路徑。

執行 Vagrant 命令

完成 Vagrantfile 的編寫和腳本的準備後，您可以使用 Vagrant CLI 來管理虛擬機：

啟動虛擬機並執行配置:
```
vagrant up
```
此命令會執行以下操作：
1. 下載指定的 Box (如果本地不存在)。
2. 創建並啟動虛擬機。
3. 執行 Vagrantfile 中定義的配置器（包括 ansible.sh 腳本）。
4. 設置共享文件夾。
連接到虛擬機:
```
vagrant ssh
```
此命令會通過 SSH 連接到正在運行的虛擬機，讓您可以直接在虛擬機環境中執行命令或測試。
暫停虛擬機:
```
vagrant halt
```
關閉虛擬機，但保留其狀態，下次啟動時可以快速恢復。
重啟虛擬機:
```
vagrant reload
```
重啟虛擬機，並重新應用 Vagrantfile 中的配置。
銷毀虛擬機:
```
vagrant destroy
```
刪除虛擬機及其所有相關資源，使其恢復到初始狀態。

視覺化 Vagrant CLI 操作流程

以下圖示展示了使用 Vagrant CLI 的基本流程。

@startuml
!define DISABLE_LINK
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

start

:User Action;  :Run `vagrant init <box_name>`;
  :Generates Vagrantfile;

  :Create Provisioning Scripts (e.g., ansible.sh);
  :Update Vagrantfile (add `config.vm.provision`);
  :Configure Synced Folders;

:Run `vagrant up`;

component "Vagrant VM Lifecycle" {
  :Download Box (if needed);
  :Create VM;
  :Start VM;
  :Execute Provisioners;
  :Setup Synced Folders;
}

Vagrant VM Lifecycle --> :VM is Ready;  :Run `vagrant ssh` to connect;
  :Run `vagrant halt` to stop;
  :Run `vagrant reload` to restart and re-provision;
  :Run `vagrant destroy` to remove;

stop

@enduml

看圖說話：

此圖示描繪了使用 Vagrant CLI 的核心操作流程。整個過程始於用戶的行動。首先，用戶執行 vagrant init <box_name> 命令，這會生成一個基礎的 Vagrantfile。緊接著，用戶會創建實際的配置腳本（如 ansible.sh），並在 Vagrantfile 中配置腳本的調用（config.vm.provision）以及文件夾同步（config.vm.synced_folder）。

當用戶執行 vagrant up 命令時，Vagrant 會自動接管虛擬機的生命週期。這包括下載所需的基礎映像 (Box)，如果本地不存在的話；然後創建虛擬機實例；啟動該虛擬機；按照 Vagrantfile 中的定義執行所有配置器（Provisioners），例如運行 shell 腳本或 Ansible Playbook；最後，設置文件夾同步。

一旦這些步驟完成，虛擬機就處於「準備就緒」的狀態，可以供開發者使用。圖示還展示了後續的常用 Vagrant 命令，如 vagrant ssh 用於連接到虛擬機，vagrant halt 用於關閉虛擬機，vagrant reload 用於重啟並重新應用配置，以及 vagrant destroy 用於徹底刪除虛擬機及其所有相關資源。這個流程提供了一個高效且可重複的方式來管理本地開發環境。

本地開發環境的自動化：Vagrant 配置驗證與虛擬機創建

在完成 Vagrantfile 的編寫並配置好腳本和共享文件夾後，下一步是驗證配置文件的語法正確性，並實際創建本地虛擬機。Vagrant 提供了相應的命令來執行這些任務，確保開發環境的準確性和一致性。

驗證 Vagrant 配置

在啟動虛擬機之前，對 Vagrantfile 進行語法驗證是一個重要的步驟，可以幫助及早發現並修正錯誤。

執行驗證命令: 在包含 Vagrantfile 的目錄下，打開終端機，執行以下命令：
```
vagrant validate
```
此命令會檢查 Vagrantfile 的語法是否符合 Vagrant 的要求。如果配置文件沒有語法錯誤，命令將不會輸出任何內容，或者顯示成功的提示信息。如果存在錯誤，它會指出問題所在，幫助您進行修正。

創建本地虛擬機

一旦配置被驗證無誤，就可以使用 Vagrant CLI 來創建和啟動本地虛擬機。

啟動虛擬機: 在與 Vagrantfile 相同的目錄下，執行以下命令：
```
vagrant up
```
這個命令會觸發 Vagrant 的一系列操作：
- 下載 Box: 如果指定的基礎映像 (Box) 在本地不存在，Vagrant 會自動從 Vagrant Cloud 或配置的其他源下載。
- 創建虛擬機: 基於下載的 Box，Vagrant 會使用指定的虛擬化平台（本例中為 VirtualBox）創建一個新的虛擬機實例。
- 配置虛擬機: Vagrant 會應用 Vagrantfile 中定義的所有配置，包括：
  - 設置網路接口和 IP 地址。
  - 配置共享文件夾，實現本地目錄與虛擬機之間的同步。
  - 執行配置器 (Provisioners)，例如運行 shell 腳本來安裝軟體（如 Ansible）或執行 Ansible Playbook。
整個過程是自動化的，您只需要監控終端輸出的進度。一旦 vagrant up 命令執行完成，您的本地虛擬機就已經創建、啟動並配置好了，可以立即投入使用。

Vagrant CLI 命令概覽

Vagrant 提供了豐富的命令列工具來管理虛擬機的生命週期。運行 vagrant --help 命令可以查看所有可用的子命令及其簡要說明。

常用 Vagrant CLI 命令:

vagrant init <box_name>: 在當前目錄創建一個新的 Vagrantfile，並指定基礎映像。
vagrant up: 創建並啟動虛擬機，同時執行配置器。
vagrant ssh: 通過 SSH 連接到正在運行的虛擬機。
vagrant halt: 關閉虛擬機。
vagrant reload: 重啟虛擬機，並重新應用 Vagrantfile 中的配置。
vagrant destroy: 刪除虛擬機及其所有相關資源。
vagrant validate: 驗證 Vagrantfile 的語法。
vagrant status: 顯示虛擬機當前的運行狀態。

視覺化 Vagrant 虛擬機創建與管理流程

以下圖示總結了使用 Vagrant CLI 創建和管理本地虛擬機的流程。

@startuml
!define DISABLE_LINK
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

start

component "Vagrantfile Preparation" {
  :Create Project Directory;
  :Run `vagrant init <box_name>`;
  :Edit Vagrantfile (Box, Network, Sync Folder);
  :Create Provisioning Scripts;
  :Add Provisioners to Vagrantfile;
  :Run `vagrant validate`;
}

component "VM Lifecycle Management" {
  :Run `vagrant up`;
  :  - Download Box (if needed);
  :  - Create VM Instance;
  :  - Start VM;
  :  - Apply Provisioners;
  :  - Setup Synced Folders;
  :VM Ready for Use;    :Run `vagrant ssh` (Connect);
    :Run `vagrant halt` (Stop);
    :Run `vagrant reload` (Restart & Re-provision);
    :Run `vagrant destroy` (Remove);
  }

Vagrantfile Preparation --> VM Lifecycle Management : Initiates VM Creation

stop

@enduml

看圖說話：

此圖示詳細闡述了使用 Vagrant CLI 來管理本地開發環境的完整流程。首先，在「Vagrantfile Preparation」階段，用戶需要創建一個專案目錄，然後執行 vagrant init 命令來生成基礎的 Vagrantfile。接下來，用戶會編輯這個 Vagrantfile，指定使用的基礎映像 (Box)、網路配置以及文件夾同步設置。同時，用戶也會創建實際的配置腳本，並將它們添加到 Vagrantfile 的 Provisioner 部分。在完成這些配置後，執行 vagrant validate 命令來確保 Vagrantfile 的語法正確無誤，這是一個預防性措施，有助於避免後續出現問題。

一旦配置驗證通過，流程進入「VM Lifecycle Management」階段。用戶執行 vagrant up 命令，Vagrant 會自動執行一系列操作：如果本地沒有所需的基礎映像，則會下載；接著創建虛擬機實例；啟動虛擬機；應用所有定義的 Provisioners（如運行腳本安裝軟體）；最後設置文件夾同步。完成這些步驟後，虛擬機就已準備就緒，可用於開發。圖示也展示了其他關鍵的生命週期管理命令，如 vagrant ssh 用於連接虛擬機，vagrant halt 用於關閉，vagrant reload 用於重啟並重新配置，以及 vagrant destroy 用於徹底刪除虛擬機。整個流程提供了一個標準化且可重複的方式來搭建和管理本地開發環境。

發展視角： 績效與成就視角 結論：

縱觀現代軟體開發的多元挑戰，Vagrant 所代表的自動化環境建置流程，其價值遠不止於技術效率的提升。相較於傳統手動配置的高度變異性與時間耗損，它將「環境即程式碼」的抽象理念，轉化為具體、可複製、可驗證的標準化資產。這一步雖然存在初期的學習曲線與建置成本，卻是解決「在我電腦上可以跑」此一典型組織內耗的根本解方，能將團隊的寶貴心力從瑣碎的環境除錯，重新聚焦於核心的業務價值創造。

展望未來，這種聲明式環境定義的思維模式，將是團隊銜接容器化（如 Docker）與雲原生架構的關鍵基石。它不僅是一種技術實踐，更是培養工程師「基礎設施即程式碼」系統思維的訓練場，為應對日趨複雜的分散式系統挑戰預先儲備能力。

玄貓認為，對於追求卓越工程文化與高效能交付的組織而言，將此類環境自動化流程確立為團隊標準，是提升開發成熟度與長期競爭力的策略性投資。

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。

透過 Vagrant CLI 與腳本實現開發環境自動化

本地開發環境的自動化：Vagrant CLI 操作與腳本配置

初始化 Vagrant 環境與創建 Vagrantfile

編寫配置腳本與更新 Vagrantfile

配置本地目錄共享

執行 Vagrant 命令

視覺化 Vagrant CLI 操作流程

看圖說話：

本地開發環境的自動化：Vagrant 配置驗證與虛擬機創建

驗證 Vagrant 配置

創建本地虛擬機

Vagrant CLI 命令概覽

視覺化 Vagrant 虛擬機創建與管理流程

看圖說話：

玄貓

初始化 Vagrant 環境與創建 `Vagrantfile`

編寫配置腳本與更新 `Vagrantfile`