產生指標的參考文件

此頁面示範如何產生指標參考文件。

準備開始

需求

• 您需要一部執行 Linux 或 macOS 的機器。

• 您需要安裝這些工具

  • Python v3.7.x+
  • Git
  • Golang 版本 1.13+
  • Pip 用於安裝 PyYAML
  • PyYAML v5.1.2
  • make
  • gcc 編譯器/連結器
  • Docker (僅 kubectl 命令參考需要)

• 您的 PATH 環境變數必須包含必要的建置工具，例如 Go 二進位檔和 python。

• 您需要知道如何建立提取請求到 GitHub 儲存庫。這涉及建立您自己的儲存庫分支。如需更多資訊，請參閱從本機副本工作。

克隆 Kubernetes 儲存庫

指標產生發生在 Kubernetes 儲存庫中。若要克隆儲存庫，請將目錄變更為您要讓克隆存在的目錄。

然後，執行以下命令

git clone https://www.github.com/kubernetes/kubernetes 

這會在您目前的工作目錄中建立一個 kubernetes 資料夾。

產生指標

在克隆的 Kubernetes 儲存庫中，找到 test/instrumentation/documentation 目錄。指標文件在此目錄中產生。

每個發行版本都會新增新的指標。在您執行指標文件產生器腳本後，複製指標文件到 Kubernetes 網站並發布更新的指標文件。

若要產生最新的指標，請確保您位於克隆的 Kubernetes 目錄的根目錄。然後，執行以下命令

./test/instrumentation/update-documentation.sh

若要檢查變更，請執行

git status

輸出類似於

./test/instrumentation/documentation/documentation.md
./test/instrumentation/documentation/documentation-list.yaml

複製產生的指標文件到 Kubernetes 網站儲存庫

1. 設定 Kubernetes 網站根目錄環境變數。

   執行以下命令以設定網站根目錄

   export WEBSITE_ROOT=<path to website root>
   

2. 複製產生的指標檔案到 Kubernetes 網站儲存庫。

   cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"
   

   注意

   如果您收到錯誤，請檢查您是否有複製檔案的權限。您可以使用 chown 將檔案所有權變更回您自己的使用者。

建立提取請求

若要建立提取請求（pull request），請依照開啟提取請求中的指示操作。

接下來呢

• 貢獻上游
• 為 Kubernetes 組件和工具產生參考文件
• 產生 kubectl 命令的參考文件