Edit This Page

为 Kubernetes 联邦 API 生成参考文档

本节介绍如何为 Kubernetes 联邦 API 自动生成参考文档。

• 准备开始
• 运行 update-federation-api-docs.sh 脚本
• 接下来

准备开始

• 你需要安装 Git。

• 你需要安装 1.9.1 或更高版本的 Golang，并在环境变量中设置你的 $GOPATH。

• 你需要安装 Docker。

• 你需要知道如何在一个 GitHub 项目仓库中创建一个 PR。一般来说，这涉及到创建仓库的一个分支。想了解更多信息，请参见创建一个文档 PR。

运行 update-federation-api-docs.sh 脚本

如果你还没有 Kubernetes 联邦的源码，现在下载：

mkdir $GOPATH/src
cd $GOPATH/src
go get github.com/kubernetes/federation

确定本地 kubernetes/federation 仓库的主目录。 例如，如果按照前面的步骤获取联邦的源码，则主目录是 $GOPATH/src/github.com/kubernetes/federation。 下文将该目录称为 <fed-base>。

运行文档生成脚本：

cd <fed-base>
hack/update-federation-api-reference-docs.sh

脚本运行 k8s.gcr.io/gen-swagger-docs 镜像来生成以下参考文档：

• /docs/api-reference/extensions/v1beta1/operations.html
• /docs/api-reference/extensions/v1beta1/definitions.html
• /docs/api-reference/v1/operations.html
• /docs/api-reference/v1/definitions.html

生成的文件不会被自动发布。你必须手工将它们复制到 kubernetes/website 仓库。

以下文件发布在 kubernetes.io/docs/reference：

• Federation API v1 Operations
• Federation API v1 Definitions
• Federation API extensions/v1beta1 Operations
• Federation API extensions/v1beta1 Definitions

接下来

• 为 Kubernetes API 生成参考文档
• 为 kubectl 命令集生成参考文档
• 为 Kubernetes 组件和工具生成参考页

反馈

此页是否对您有帮助？

Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.