這份手冊寫給安裝、設定 emfor 的人,以及撰寫使用 emfor 之應用程式的人。它說明各個元件如何配合,並逐步帶過每項工作;docs/deploy/ 底下的文件與各 client 的 README 有完整細節,會在相關之處附上連結(這些文件為英文)。
本手冊描述 emfor 0.5。
| 章節 | 內容 |
|---|---|
| 1. 基本概念 | daemon、state store、client、DNS、健康狀態,以及出問題時會發生什麼事 |
| 2. 安裝 | 建置、安裝路徑前綴、systemd、FreeBSD,以及 client 函式庫 |
| 3. 設定 | emfor.toml 的每個 table 與 key、驗證規則,以及 reload 能改變什麼 |
| 4. 健康檢查 | tcp、http、exec、plugin 與 emfor-check;rise、fall、排程與 reason |
| 5. 選擇 backend | 各種 balance 方式、on_all_down,以及過期的 store |
| 6. Client 函式庫 | 從 Rust、C、Go、Python、Perl、PHP 查詢 backend |
| 7. DNS | DNS server、它的回答、SRV 記錄、從主機 resolver 轉送,以及快取 |
| 7b. DNS 做法 | 用 emfor 的 DNS 回答設定 nginx、HAProxy、Caddy、Prometheus 與 pf,以及自己會查 SRV 記錄的 client |
| 8. 維運 | 指令、signal 與 reload、emfor status、emfor lookup、metrics、log、結束代碼、磁碟上的 store、升級 |
| 9. 疑難排解 | 症狀、原因與處理方式 |
| 10. 從 HAProxy 或 Consul 搬過來 | 同樣的設定在 emfor 裡長什麼樣子、哪些東西沒有對應,以及如何與現有方案並排試用 emfor |
第一次接觸 emfor?先讀第 1 章,接著照 README 的快速上手操作一次,再讀第 3 章。
慣例
- 範例中的服務名稱都以
.svc.emfor結尾,也就是預設的 DNS zone。任何類似主機名稱的名字都可以用;只有 zone 之下的名稱能透過 DNS 解析。 - 路徑都是預設值:設定檔在
/etc/emfor/emfor.toml,store 在/var/lib/emfor/state.mdb。 $開頭的是你輸入的指令;沒有$的是輸出。- 設定 key、指令、log 與錯誤訊息保留原文,方便對照實際畫面。