生成指標的參考文件

此頁面演示瞭如何生成指標參考文件。

準備工作

要求

• 您需要一臺執行 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 將檔案所有權改回您的使用者。

建立拉取請求

要建立拉取請求，請按照 開啟拉取請求 中的說明進行操作。

下一步

• 貢獻到上游
• 為 Kubernetes 元件和工具生成參考文件
• 生成 kubectl 命令的參考文件