为指标生成参考文档

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

开始之前

要求

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

  • 您需要安装以下工具

  • 您的 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)

要创建拉取请求,请按照 打开一个拉取请求 中的说明操作。

接下来


最后修改于 2024 年 1 月 22 日 上午 10:02 PST: 清理 metrics-reference.md (48509eebee)