为 Kubernetes API 生成参考文档
此页面介绍如何更新 Kubernetes API 参考文档。
Kubernetes API 参考文档是从 Kubernetes OpenAPI 规范 使用 kubernetes-sigs/reference-docs 生成代码生成的。
如果您在生成的文档中发现错误，需要 上游修复。
如果您只需要从 OpenAPI 规范重新生成参考文档，请继续阅读此页面。
开始之前
要求
您需要一台运行 Linux 或 macOS 的机器。
您需要安装以下工具
您的
PATH环境变量必须包含所需的构建工具，例如Go二进制文件和python。您需要知道如何创建 GitHub 仓库的拉取请求。这涉及创建您自己的仓库分叉。有关更多信息，请参阅 从本地克隆工作。
设置本地仓库
创建一个本地工作区并设置您的 GOPATH
mkdir -p $HOME/<workspace>
export GOPATH=$HOME/<workspace>
获取以下仓库的本地克隆
git clone github.com/kubernetes-sigs/reference-docs
移动到 reference-docs 仓库的 gen-apidocs 目录并安装所需的 Go 包
go get -u github.com/go-openapi/loads
go get -u github.com/go-openapi/spec
如果您还没有 kubernetes/website 仓库，请立即获取它
git clone https://github.com/<your-username>/website
获取 kubernetes/kubernetes 仓库的克隆
git clone https://github.com/kubernetes/kubernetes
您的 kubernetes/kubernetes 仓库克隆的基目录是
<your-path-to>/kubernetes/kubernetes.剩余步骤将您的基目录称为<k8s-base>。您的 kubernetes/website 仓库克隆的基目录是
<your-path-to>/website。 剩余步骤将您的基目录称为<web-base>。您的 kubernetes-sigs/reference-docs 仓库克隆的基目录是
<your-path-to>/reference-docs。 剩余步骤将您的基目录称为<rdocs-base>。
生成 API 参考文档
本节介绍如何生成 已发布的 Kubernetes API 参考文档。
设置构建变量
- 将
K8S_ROOT设置为<k8s-base>。 - 将
K8S_WEBROOT设置为<web-base>。 - 将
K8S_RELEASE设置为您想要构建的文档版本。 例如，如果您想为 Kubernetes 1.17.0 构建文档，请将K8S_RELEASE设置为 1.17.0。
例如
export K8S_WEBROOT=<your-path-to>/website
export K8S_ROOT=<your-path-to>/kubernetes
export K8S_RELEASE=1.17.0
创建版本目录并获取 Open API 规范
updateapispec 构建目标会创建版本化的构建目录。 创建目录后，将从 <k8s-base> 仓库获取 Open API 规范。 这些步骤可确保配置文件和 Kubernetes Open API 规范的版本与发布版本匹配。 版本目录名称遵循 v<major>_<minor> 模式。
在 <rdocs-base> 目录中，运行以下构建目标
cd <rdocs-base>
make updateapispec
构建 API 参考文档
copyapi 目标构建 API 参考并将其生成的 文件复制到 <web-base> 中的目录。 在 <rdocs-base> 中运行以下命令
cd <rdocs-base>
make copyapi
验证是否已生成这两个文件
[ -e "<rdocs-base>/gen-apidocs/build/index.html" ] && echo "index.html built" || echo "no index.html"
[ -e "<rdocs-base>/gen-apidocs/build/navData.js" ] && echo "navData.js built" || echo "no navData.js"
转到本地 <web-base> 的基目录，并查看哪些文件已被修改
cd <web-base>
git status
输出类似于
static/docs/reference/generated/kubernetes-api/v1.35/css/bootstrap.min.css
static/docs/reference/generated/kubernetes-api/v1.35/css/font-awesome.min.css
static/docs/reference/generated/kubernetes-api/v1.35/css/stylesheet.css
static/docs/reference/generated/kubernetes-api/v1.35/fonts/FontAwesome.otf
static/docs/reference/generated/kubernetes-api/v1.35/fonts/fontawesome-webfont.eot
static/docs/reference/generated/kubernetes-api/v1.35/fonts/fontawesome-webfont.svg
static/docs/reference/generated/kubernetes-api/v1.35/fonts/fontawesome-webfont.ttf
static/docs/reference/generated/kubernetes-api/v1.35/fonts/fontawesome-webfont.woff
static/docs/reference/generated/kubernetes-api/v1.35/fonts/fontawesome-webfont.woff2
static/docs/reference/generated/kubernetes-api/v1.35/index.html
static/docs/reference/generated/kubernetes-api/v1.35/js/jquery.scrollTo.min.js
static/docs/reference/generated/kubernetes-api/v1.35/js/navData.js
static/docs/reference/generated/kubernetes-api/v1.35/js/scroll.js
API 参考位置和版本控制
生成的 API 参考文件（HTML 版本）复制到 <web-base>/static/docs/reference/generated/kubernetes-api/v1.35/。 此目录包含独立的 HTML API 文档。
说明
位于<web-base>/content/en/docs/reference/kubernetes-api/ 的 API 参考的 Markdown 版本是使用 gen-resourcesdocs 生成器单独生成的。本地测试 API 参考
发布 API 参考的本地版本。 验证 本地预览。
cd <web-base>
git submodule update --init --recursive --depth 1 # if not already done
make container-serve
提交更改
在 <web-base> 中，运行 git add 和 git commit 以提交更改。
将您的更改作为 拉取请求 提交到 kubernetes/website 仓库。 监控您的拉取请求，并根据需要回复审阅者的评论。 继续监控您的拉取请求，直到它被合并。