配置即代碼:Ansible 入門

配置即代碼:Ansible 入門

之前負責產品研發時,常常需要因應客戶需求,更新終端裝置上的應用程式。因為終端裝置在廠區可能一次就是幾十幾百台,如果用手動更新大概當天就不用做事了。Ansible 這類組態管理(Configuration Management)軟體就是為此而生。相對於同類軟體,Ansible 的系統需求單純,只要 Client 端有安裝 Python 即可,很適合資源受限的嵌入式系統。

這篇會用 Ansible 來模擬簡單的 Python 應用程式更新,看看它如何處理 Deployment 的問題。

Install Ansible and Setup Environment

首先在 Server 端安裝 Ansible,如果你使用的是 Ubuntu 的話,只需要執行

sudo apt-get install ansible

同時,使用一台 Raspberry Pi Model B 來當成終端裝置,沒有 RPi 也可以用 VirtualBox + Vagrant 搭建虛擬機來使用。

因為 Ansible 是使用 SSH 進行遠端操作,記得要打開 RPi 上的 SSH

sudo raspi-config

選擇 Interfacing Options 後,打開 P2 SSH。

最後要記得確認 RPi 上有 Python

python3 --version

Setup Host Information

我們必須告訴 Ansible 要連接的主機是哪些,相關資訊是什麼,這些 Client 端的裝置,在 Ansible 術語中稱為 Inventory。先假設工作目錄為 playbook,則先在該目錄下新增一個 hosts,來描述終端裝置

playbook/
    hosts               *# inventory file for production servers*

該檔案內容為

pi ansible_host=192.168.5.10 ansible_user=pi

由內容可以知道,該裝置名稱是 pi,IP 是 192.168.5.10,而用來登入的使用者名稱為 pi。

接著可以執行 Ansible 的測試命令 ping,當裝置收到後,會回應 pong,表示兩者間通訊正常

# -i is inventory
# -m is command module

ken@ken-Lenovo-ideapad-330-15ICH:~/git/ansible/raspberry/playbooks$ ansible pi -i hosts -m ping
pi | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}

Setup Ansible Config File

因為每台裝置需要寫 hosts 來對應會很麻煩,如果裝置有共通欄位,例如 RPi 的 remote_user 都是 pi,能不能使用共同文件來設定?Ansible 的 config 檔就是為了滿足這個需求。我們在工作目錄下加入 config

playbook/
    hosts               *# inventory file for production servers
    ansible.cfg         *# ansible config file*

檔案內容如下

[defaults]
inventory = hosts
remote_user = pi
host_key_checking = False

將預設的 inventory 指向 hosts,預設的 user 設為 pi,如此一來,inventory file 中就無需描述多餘資訊,hosts 可以改成

pi ansible_host=192.168.5.10

因為 config 檔中已經指定 inventory 為 hosts,之後執行 Ansible 時就不用指定 -i 了。這次使用另外一個 Ansible 的命令來看 uptime 的時間

ken@ken-Lenovo-ideapad-330-15ICH:~/git/ansible/raspberry/playbooks$ ansible pi -m command -a uptime
pi | SUCCESS | rc=0 >>
    16:28:46 up  2:48,  4 users,  load average: 0.08, 0.05, 0.01

如上,可以看到 RPi 從啟動到下指令,中間經過 2:48。

Write a Playbook

在前面的步驟中,我們透過 Ansible 對遠端裝置進行單次指令,但如果組態設定或部署需要一次進行多次指令的話,我們可以怎麼做?Ansible 有個工具稱為 playbook,類似劇本,只要 user 依照 yaml 格式編寫好,Ansible 就會根據 playbook 來執行指令。

為了使用 playbook,在工作目錄中加入 playbook 的檔案

playbook/
    hosts               *# inventory file for production servers
    ansible.cfg         *# ansible config file
    pi-update.yml       *# ansible playbook*

內容如下

- name: Update python script
  hosts: end-devices
  become: True
  tasks:
  - name: copy python file
    copy: src=files/hello.py dest=/home/pi/ansible/hello.py mode=0644
  - name: run python file
    command: python3 /home/pi/ansible/hello.py

在這個 playbook 中,執行對象是 end-devices 這個 inventory 群組。這個 playbook 存在兩個 task,第一個用來將 hello.py 這支 python 的 copy 到終端裝置;第二個用來執行終端裝置上的 python 程式。

可以看到,inventory 由原先的 hosts 改為 end-devices,這是因為 inventory 可能是由多台機器組成的群組,因此我們改寫原先的 inventory file,將它變成

[end-devices]
pi ansible_host=192.168.5.10

在開頭加入群組名稱。

接著,在工作目錄創建要複製過去的檔案

playbook/
    hosts               *# inventory file for production servers
    ansible.cfg         *# ansible config file
    pi-update.yml       *# ansible playbook
    files/              *# files
      hello.py

hello.py 是個 python 的程式碼,用來印出 “Hello, world”

print("Hello, world")

相關準備完成了,來看看執行的結果。執行 playbook 需要使用 ansible-playbook 這個命令

ken@ken-Lenovo-ideapad-330-15ICH:~/git/ansible/raspberry/playbooks$ ansible-playbook pi-update.yml

PLAY [Update python script] ********************************************************************

TASK [Gathering Facts] ********************************************************************
ok: [pi]

TASK [copy python file] ********************************************************************
changed: [pi]

TASK [run python file] ********************************************************************
changed: [pi]

PLAY RECAP ********************************************************************
pi                  : ok=3    changed=2    unreachable=0    failed=0

Ansible 會先收集裝置上的資訊,然後依照 playbook 來執行 task,changed 表示裝置被實際變動,由結果可看到 Ansible 將 hello.py 複製到 RPi 上,並且執行 python script。

Add Debug Information

但是 hello.py 有印出 “Hello, world”,為什麼在執行結果沒看到呢?這是因為印出的資訊是在 RPi 上,如果要將輸出結果顯示到 Ansible 的結果中,可以修改 playbook 如下

- name: Update python script
  hosts: end-devices
  become: True
  tasks:
  - name: copy python file
    copy: src=files/hello.py dest=/home/pi/ansible/hello.py mode=0644
  - name: run python file
    command: python3 /home/pi/ansible/hello.py
    register: hello
  - debug: var=hello

將 task 的結果用 register 註冊為 variable,再使用 debug 印出,方便除錯。

好的,再執行一次 ansible-playbook

ken@ken-Lenovo-ideapad-330-15ICH:~/git/ansible/raspberry/playbooks$ ansible-playbook pi-update.yml

PLAY [Update python script] ********************************************************************

TASK [Gathering Facts] ********************************************************************
ok: [pi]

TASK [copy python file] ********************************************************************
ok: [pi]

TASK [run python file] ********************************************************************
changed: [pi]

TASK [debug] ********************************************************************
ok: [pi] => {
    "hello": {
        "changed": true, 
        "cmd": [
            "python3", 
            "/home/pi/ansible/hello.py"
        ], 
        "delta": "0:00:00.779588", 
        "end": "2019-11-25 20:06:11.911999", 
        "failed": false, 
        "rc": 0, 
        "start": "2019-11-25 20:06:11.132411", 
        "stderr": "", 
        "stderr_lines": [], 
        "stdout": "Hello, world", 
        "stdout_lines": [
            "Hello, world"
        ]
    }
}

PLAY RECAP ********************************************************************
pi                 : ok=4    changed=1    unreachable=0    failed=0

這次就可以看到 stdout 結果是 “Hello, world”,同時因為 hello.py 已經複製過了,第一個 task 狀態改為 ok,而非 changed。

小結

初次上路,好在沒有翻車。Ansible 相對 expect 這類響應式腳本複雜不少,但需要的 cost 真的很低,只需要 python 就可以運行。優點是 framework 架構完整,修改性跟移植性高,當專案成長到一定規模,expect 維護起來很麻煩時,就可以考慮用 Ansible 來補充。

Reference

Read more

Weekly Issue 第 18 期:OpenAI 發布 AI 瀏覽器 Atlas

OpenAI 最近發布 AI 瀏覽器,加上稍早的 Sora 2,在技術圈中引起一些討論。 我認為 OpenAI 嘗試將模型領域的優勢帶到應用面,但這也讓它顯得更像是一家營利公司,而非研究單位(雖然現在沒人會把 OpenAI 當成研究單位了)。 🗞️ 熱門新聞 Dane Stuckey (OpenAI CISO) on prompt injection risks for ChatGPT Atlas Simon Willison 聊了他對 OpenAI Altas 的看法,主要是資安方面。 幾個點:1) 提示詞注入問題依然存在,而且還沒有好解法;2) OpenAI 設計了登出模式與監視模式,讓使用者更容易意識到安全性。 在我看來第二點很重要,好設計應該要避免使用者犯錯,如果 AI 瀏覽器可以在登出狀態下執行,能避免掉很多麻煩的狀況,當然這意味著沒辦法自動購物。

By Ken Chen

Weekly Issue 第 17 期:n8n 在 C 輪募得 180m

現在新創企業已經離不開 AI 了。像 n8n 這樣的自動化工具,重新用 AI 話題包裝後,可以在自由市場上募得鉅款;Postman 也需要在它的口號中,強調對 AI 的重要性。 我相信 AI 讓生活變得更方便,我剛到新國家,對任何事情都不熟時,AI 給了我很多幫助。但市場的話題像一場無差別的風暴,每個公司都面對一支麥克風,麥克風傳出的經 AI 編輯過的聲音。 🗞️ 熱門新聞 n8n raises $180m to get AI closer to value with orchestration n8n C 輪募了 180M 美元,沒想到它可以這麼值錢。 基於 zapier 只有 5B 的估值,

By Ken Chen

Weekly Issue 第 16 期:Anduril 的 MVP

近期嘗試降低 AI 相關選文,主要是因為我在閱讀時,不容易判斷內容是正確還是錯誤。本次選的「AI Evals 大辯論」在這點上就做得很棒,正反意見並陳,讓讀者知道自己哪些論點也有人支持,哪些論點具有爭議。 🗞️ 熱門新聞 The Amusement Park for Engineers 原本看是 Anduril 嘀咕幾聲(我對國防工業沒興趣),但看到一半覺得太讚了,推薦所有做產品的人閱讀。 這句話開始點亮我的眼睛:「那座臨時搭建的塔,是我們自掏腰包、為了驗證可行性而做的,幫助攔截了近一千磅的大麻,並導致數十起毒品走私逮捕 」 業界都說要做 MVP,但到底什麼是 viable?沒有 viable 的 MVP 只能稱為 prototype 而已。合作的 PM 有次說的傳神:「別人要樣品屋,但我們只有沒屋頂的牆壁。」 這篇雖然沒有講到 agile,卻做到

By Ken Chen

Weekly Issue 第 15 期:Go 語言從 1.25 支援 Flight Recorder

最近安排旅遊計畫,會到 Brisbane 居住三個月,突然跟熟悉的環境分開,用陌生眼光看待周圍一切,真是個特別的體驗。 世界依然在轉動,只是用了不同速度,反映在每週週報上,是項目變少了,可是內容變長了。 🗞️ 熱門新聞 Flight Recorder in Go 1.25 Go 1.25 開始支援 Flight Recorder。 以前要抓 trace,都是要等到事發後才能抓,有沒有可能事發前抓呢?有,原理很簡單,配置一塊記憶體存放臨時的 trace,如果符合條件,輸出持久化,否則丟棄,這就是 Flight Recorder。 官方給的範例很讚,像 slow request 這類例子,常常是處理 request 時遇到問題,在沒有 Flight Recorder

By Ken Chen