大网数据广告活动
Kubernetes 部署与运维

为指标生成参考文档

· 52CE 我爱测

## 克隆 Kubernetes 仓库 {#cloning-the-kubernetes-repository}

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

克隆 Kubernetes 仓库 {#cloning-the-kubernetes-repository}

指标的生成发生在 Kubernetes 仓库中。 要克隆此仓库,请将目录更改为你要克隆到的目标位置。

然后,执行以下命令:

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

这将在当前工作目录中创建一个 kubernetes 文件夹。

生成指标 {#generate-the-metrics}

在克隆的 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 网站仓库 {#copy-the-generated-metrics-documentation-file-to-the-kubernetes-website-repository}

  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 命令将文件所有权更改回你自己的用户。

创建 PR {#creating-a-pull-request}

要创建 PR,请按照提 PR 中的说明操作。

来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
Kubernetes 文档贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。