为指标生成参考文档

此页面演示了指标参考文档的生成。

开始之前

要求

• 您需要一台运行 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 命令生成参考文档