kuberhealthy/kuberhealthy:README 來源編輯指南
根據 README、倉庫資料與授權整理 kuberhealthy/kuberhealthy 的安裝與核驗路徑。
專案定位
kuberhealthy/kuberhealthy 的 README 將專案描述為「A Kubernetes operator for running synthetic checks as pods. Works great with Prometheus!」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「Kuberhealthy」下寫到:Kuberhealthy is an operator for synthetic monitoring. It ships metrics to Prometheus and enables you to package your synthetic monitoring as Kubernetes manifests.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Why Kuberhealthy?」與相關條目,可以先判斷它是否處理你的實際問題:Use any language , Go, or anything that fits in a container。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Run multi-step workflows , simulate a real user: log in, create a record, verify it, clean it up。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「How it works」等段落。可確認的線索包括:Kuberhealthy provides the HealthCheck custom resource definition. Each HealthCheck tells Kuberhealthy to start a short-lived checker pod on a schedule.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: apiVersion: kuberhealthy.github.io/v2 kind: HealthCheck metadata: name: deployment namespace: kuberhealthy spec: runInterval: 10m timeout: 5m podSpec: spec: containers: - name: deployment image: docker.io/kuberhealthy/deployment-check:v0.1.1 env: - name: CHECK_DEPLOYMENT_REPLICAS value: "4" - name: CHECK_DEPLOYMENT_ROLLING_UPDATE value: "true" resources: requests: 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Why Kuberhealthy?」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「How it works」段落提到:The checker pod runs your validation logic, then reports back to Kuberhealthy. Results flow to the built-in status UI, JSON API, and Prometheus metrics endpoint.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Own your checks as code , checks are Kubernetes manifests, so ship them alongside your app!。