为指标生成参考文档

本页演示如何生成指标参考文档。

开始之前

要求

• 你需要一台运行 Linux 或 macOS 的机器。

• 你需要安装以下工具：

  • Python v3.7.x+
  • Git
  • Golang 版本 1.13+
  • Pip（用于安装 PyYAML）
  • PyYAML v5.1.2
  • make
  • gcc 编译器/链接器
  • Docker（仅 kubectl 命令参考需要）

• 你的 PATH 环境变量必须包含所需的构建工具，例如 Go 二进制文件和 python。

• 你需要知道如何向 GitHub 仓库提交 Pull Request。这涉及到创建仓库的你自己的分支。有关更多信息，请参阅 Work from a local clone。

克隆 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

要提交 Pull Request，请按照 Opening a pull request 中的说明进行。

下一步

• Contribute-upstream
• 为 Kubernetes 组件和工具生成参考文档
• 为 kubectl 命令生成参考文档