为 Kubernetes API 生成参考文档
此页面展示如何更新 Kubernetes API 参考文档。
Kubernetes API 参考文档是使用 kubernetes-sigs/reference-docs 生成代码从 Kubernetes OpenAPI 规范 构建的。
如果您在生成的文档中发现错误，则需要 在上游修复它们。
如果您只需要从 OpenAPI 规范重新生成参考文档，请继续阅读此页面。
开始之前
要求
您需要一台运行 Linux 或 macOS 的机器。
您需要安装以下工具
您的
PATH环境变量必须包含必要的构建工具，例如Go二进制文件和python。您需要了解如何向 GitHub 存储库创建拉取请求。这涉及创建您自己的存储库分叉。有关更多信息，请参阅 从本地克隆工作。
设置本地存储库
创建一个本地工作区并设置您的 GOPATH
mkdir -p $HOME/<workspace>
export GOPATH=$HOME/<workspace>
获取以下存储库的本地克隆
go get -u github.com/kubernetes-sigs/reference-docs
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 $GOPATH/src/github.com/<your-username>/website
获取 kubernetes/kubernetes 存储库的克隆，作为 k8s.io/kubernetes
git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes
您克隆的 kubernetes/kubernetes 存储库的基目录为
$GOPATH/src/k8s.io/kubernetes.剩余步骤将您的基目录称为<k8s-base>。您克隆的 kubernetes/website 存储库的基目录为
$GOPATH/src/github.com/<your username>/website。 剩余步骤将您的基目录称为<web-base>。您克隆的 kubernetes-sigs/reference-docs 存储库的基目录为
$GOPATH/src/github.com/kubernetes-sigs/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=${GOPATH}/src/github.com/<your-username>/website
export K8S_ROOT=${GOPATH}/src/k8s.io/kubernetes
export K8S_RELEASE=1.17.0
创建版本化目录并获取 Open API 规范
updateapispec 构建目标将创建版本化的构建目录。创建目录后，将从 <k8s-base> 存储库中获取 Open API 规范。这些步骤确保配置文
在 <rdocs-base> 目录中，运行以下构建目标
cd <rdocs-base>
make updateapispec
构建 API 参考文档
copyapi 目标将构建 API 参考并将生成的文
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.31/css/bootstrap.min.css
static/docs/reference/generated/kubernetes-api/v1.31/css/font-awesome.min.css
static/docs/reference/generated/kubernetes-api/v1.31/css/stylesheet.css
static/docs/reference/generated/kubernetes-api/v1.31/fonts/FontAwesome.otf
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.eot
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.svg
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.ttf
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.woff
static/docs/reference/generated/kubernetes-api/v1.31/fonts/fontawesome-webfont.woff2
static/docs/reference/generated/kubernetes-api/v1.31/index.html
static/docs/reference/generated/kubernetes-api/v1.31/js/jquery.scrollTo.min.js
static/docs/reference/generated/kubernetes-api/v1.31/js/navData.js
static/docs/reference/generated/kubernetes-api/v1.31/js/scroll.js
更新 API 参考索引页
在为新发布生成参考文档时，请使用新版本号更新文件 <web-base>/content/en/docs/reference/kubernetes-api/api-index.md。
打开
<web-base>/content/en/docs/reference/kubernetes-api/api-index.md进行编辑，并更新 API 参考版本号。例如--- title: v1.17 --- [Kubernetes API v1.17](/docs/reference/generated/kubernetes-api/v1.17/)打开
<web-base>/content/en/docs/reference/_index.md进行编辑，并添加指向最新 API 参考的新链接。删除最旧的 API 参考版本。应
本地测试 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 存储库。监视您的拉取请求，并在需要时回复审阅者评论。继续监视您的拉取请求，直到它被合并。