428 lines
15 KiB
Markdown
428 lines
15 KiB
Markdown
---
|
||
title: 为 kubectl 命令集生成参考文档
|
||
content_type: task
|
||
weight: 90
|
||
---
|
||
|
||
<!--
|
||
title: Generating Reference Documentation for kubectl Commands
|
||
content_type: task
|
||
weight: 90
|
||
-->
|
||
|
||
<!-- overview -->
|
||
|
||
<!--
|
||
This page shows how to generate the `kubectl` command reference.
|
||
-->
|
||
|
||
本页面描述了如何生成 `kubectl` 命令参考。
|
||
|
||
<!--
|
||
This topic shows how to generate reference documentation for
|
||
[kubectl commands](/docs/reference/generated/kubectl/kubectl-commands)
|
||
like
|
||
[kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) and
|
||
[kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint).
|
||
This topic does not show how to generate the
|
||
[kubectl](/docs/reference/generated/kubectl/kubectl/)
|
||
options reference page. For instructions on how to generate the kubectl options
|
||
reference page, see
|
||
[Generating Reference Pages for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/).
|
||
-->
|
||
|
||
{{< note >}}
|
||
本主题描述了如何为 [kubectl 命令](/docs/reference/generated/kubectl/kubectl-commands)
|
||
生成参考文档，如 [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) 和
|
||
[kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint)。
|
||
本主题没有讨论如何生成 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 组件选项的参考页面。
|
||
相关说明请参见[为 Kubernetes 组件和工具生成参考页面](/zh/docs/contribute/generate-ref-docs/kubernetes-components/)。
|
||
{{< /note >}}
|
||
|
||
## {{% heading "prerequisites" %}}
|
||
|
||
{{< include "prerequisites-ref-docs.md" >}}
|
||
|
||
<!-- steps -->
|
||
|
||
<!--
|
||
## Setting up the local repositories
|
||
|
||
Create a local workspace and set your `GOPATH`.
|
||
-->
|
||
## 配置本地仓库
|
||
|
||
创建本地工作区并设置你的 `GOPATH`。
|
||
|
||
```shell
|
||
mkdir -p $HOME/<workspace>
|
||
export GOPATH=$HOME/<workspace>
|
||
```
|
||
|
||
<!-- Get a local clone of the following repositories: -->
|
||
获取以下仓库的本地克隆：
|
||
|
||
```shell
|
||
go get -u github.com/spf13/pflag
|
||
go get -u github.com/spf13/cobra
|
||
go get -u gopkg.in/yaml.v2
|
||
go get -u kubernetes-incubator/reference-docs
|
||
```
|
||
|
||
<!--
|
||
If you don't already have the kubernetes/website repository, get it now:
|
||
-->
|
||
如果您还没有获取过 `kubernetes/website` 仓库，现在获取之：
|
||
|
||
```shell
|
||
git clone https://github.com/<your-username>/website $GOPATH/src/github.com/<your-username>/website
|
||
```
|
||
|
||
<!-- Get a clone of the kubernetes/kubernetes repository as k8s.io/kubernetes: -->
|
||
克隆 kubernetes/kubernetes 仓库作为 k8s.io/kubernetes：
|
||
|
||
```shell
|
||
git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes
|
||
```
|
||
|
||
<!--
|
||
Remove the spf13 package from `$GOPATH/src/k8s.io/kubernetes/vendor/github.com`.
|
||
-->
|
||
从 `$GOPATH/src/k8s.io/kubernetes/vendor/github.com` 中移除 spf13 软件包。
|
||
|
||
```shell
|
||
rm -rf $GOPATH/src/k8s.io/kubernetes/vendor/github.com/spf13
|
||
```
|
||
|
||
<!-- The kubernetes/kubernetes repository provides access to the kubectl and kustomize source code. -->
|
||
kubernetes/kubernetes 仓库提供对 kubectl 和 kustomize 源代码的访问。
|
||
|
||
<!--
|
||
* Determine the base directory of your clone of the
|
||
[kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) repository.
|
||
For example, if you followed the preceding step to get the repository, your
|
||
base directory is `$GOPATH/src/k8s.io/kubernetes.`
|
||
The remaining steps refer to your base directory as `<k8s-base>`.
|
||
-->
|
||
* 确定 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 仓库的本地主目录。
|
||
例如，如果按照前面的步骤来获取该仓库，则主目录是 `$GOPATH/src/k8s.io/kubernetes.`。
|
||
下文将该目录称为 `<k8s-base>`。
|
||
|
||
<!--
|
||
* Determine the base directory of your clone of the
|
||
[kubernetes/website](https://github.com/kubernetes/website) repository.
|
||
For example, if you followed the preceding step to get the repository, your
|
||
base directory is `$GOPATH/src/github.com/<your-username>/website.`
|
||
The remaining steps refer to your base directory as `<web-base>`.
|
||
-->
|
||
* 确定 [kubernetes/website](https://github.com/kubernetes/website) 仓库的本地主目录。
|
||
例如，如果按照前面的步骤来获取该仓库，则主目录是 `$GOPATH/src/github.com/<your-username>/website`。
|
||
下文将该目录称为 `<web-base>`。
|
||
|
||
<!--
|
||
* Determine the base directory of your clone of the
|
||
[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) repository.
|
||
For example, if you followed the preceding step to get the repository, your
|
||
base directory is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.`
|
||
The remaining steps refer to your base directory as `<rdocs-base>`. -->
|
||
* 确定 [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs)
|
||
仓库的本地主目录。例如，如果按照前面的步骤来获取该仓库，则主目录是
|
||
`$GOPATH/src/github.com/kubernetes-sigs/reference-docs`。
|
||
下文将该目录称为 `<rdocs-base>`。
|
||
|
||
<!--
|
||
In your local k8s.io/kubernetes repository, check out the branch of interest,
|
||
and make sure it is up to date. For example, if you want to generate docs for
|
||
Kubernetes 1.17, you could use these commands:
|
||
-->
|
||
在本地的 k8s.io/kubernetes 仓库中，检出感兴趣的分支并确保它是最新的。例如，
|
||
如果你想要生成 Kubernetes 1.17 的文档，可以使用以下命令：
|
||
|
||
```shell
|
||
cd <k8s-base>
|
||
git checkout v1.17.0
|
||
git pull https://github.com/kubernetes/kubernetes v1.17.0
|
||
```
|
||
|
||
<!--
|
||
If you do not need to edit the kubectl source code, follow the instructions to
|
||
[Setting build variables](#setting-build-variables).
|
||
-->
|
||
如果不需要编辑 `kubectl`
|
||
源码，请按照说明[配置构建变量](#setting-build-variables)。
|
||
|
||
<!--
|
||
## Editing the kubectl source code
|
||
|
||
The kubectl command reference documentation is automatically generated from
|
||
the kubectl source code. If you want to change the reference documentation, the first step
|
||
is to change one or more comments in the kubectl source code. Make the change in your
|
||
local kubernetes/kubernetes repository, and then submit a pull request to the master branch of
|
||
[github.com/kubernetes/kubernetes](https://github.com/kubernetes/kubernetes).
|
||
-->
|
||
## 编辑 kubectl 源码
|
||
|
||
kubectl 命令的参考文档是基于 kubectl 源码自动生成的。如果想要修改参考文档，可以从修改
|
||
kubectl 源码中的一个或多个注释开始。在本地 kubernetes/kubernetes 仓库中进行修改，然后向
|
||
[github.com/kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) 的 master
|
||
分支提交 PR。
|
||
|
||
<!--
|
||
[PR 56673](https://github.com/kubernetes/kubernetes/pull/56673/files)
|
||
is an example of a pull request that fixes a typo in the kubectl source code.
|
||
|
||
Monitor your pull request, and respond to reviewer comments. Continue to monitor your
|
||
pull request until it is merged into the master branch of the kubernetes/kubernetes repository.
|
||
-->
|
||
|
||
[PR 56673](https://github.com/kubernetes/kubernetes/pull/56673/files) 是一个对 kubectl
|
||
源码中的笔误进行修复的 PR 示例。
|
||
|
||
跟踪你的 PR，并回应评审人的评论。继续跟踪你的 PR，直到它合入到 kubernetes/kubernetes 仓库的 master 分支中。
|
||
|
||
<!--
|
||
## Cherry picking your change into a release branch
|
||
|
||
Your change is now in the master branch, which is used for development of the next
|
||
Kubernetes release. If you want your change to appear in the docs for a Kubernetes
|
||
version that has already been released, you need to propose that your change be
|
||
cherry picked into the release branch.
|
||
-->
|
||
## 以 cherry-pick 方式将你的修改合入已发布分支
|
||
|
||
你的修改已合入 master 分支中，该分支用于开发下一个 Kubernetes 版本。
|
||
如果你希望修改部分出现在已发布的 Kubernetes 版本文档中，则需要提议将它们以
|
||
cherry-pick 方式合入已发布分支。
|
||
|
||
<!--
|
||
For example, suppose the master branch is being used to develop Kubernetes 1.10,
|
||
and you want to backport your change to the release-1.15 branch. For instructions
|
||
on how to do this, see
|
||
[Propose a Cherry Pick](https://git.k8s.io/community/contributors/devel/sig-release/cherry-picks.md).
|
||
|
||
Monitor your cherry-pick pull request until it is merged into the release branch.
|
||
-->
|
||
|
||
例如，假设 master 分支正用于开发 Kubernetes 1.16 版本，而你希望将修改合入到已发布的 1.15 版本分支。
|
||
相关的操作指南，请参见
|
||
[提议一个 cherry-pick](https://git.k8s.io/community/contributors/devel/sig-release/cherry-picks.md)。
|
||
|
||
跟踪你的 cherry-pick PR，直到它合入到已发布分支中。
|
||
|
||
<!--
|
||
Proposing a cherry pick requires that you have permission to set a label and a
|
||
milestone in your pull request. If you don’t have those permissions, you will
|
||
need to work with someone who can set the label and milestone for you.
|
||
-->
|
||
|
||
{{< note >}}
|
||
提议一个 cherry-pick 需要你有在 PR 中设置标签和里程碑的权限。
|
||
如果你没有，你需要与有权限为你设置标签和里程碑的人合作完成。
|
||
{{< /note >}}
|
||
|
||
<!--
|
||
## Setting build variables
|
||
|
||
Go to `<rdocs-base>`, and open the `Makefile` for editing:
|
||
-->
|
||
## 设置构建变量 {#setting-build-variables}
|
||
|
||
进入 `<rdocs-base>` 目录, 打开 `Makefile` 进行编辑：
|
||
|
||
<!--
|
||
* Set `K8S_ROOT` to `<k8s-base>`.
|
||
* Set `K8S_WEBROOT` to `<web-base>`.
|
||
* Set `K8S_RELEASE` to the version of the docs you want to build.
|
||
For example, if you want to build docs for Kubernetes 1.17, set `K8S_RELEASE` to 1.17.
|
||
|
||
For example, update the following variables:
|
||
-->
|
||
* 设置 `K8S_ROOT` 为 `<k8s-base>`。
|
||
* 设置 `K8S_WEBROOT` 为 `<web-base>`。
|
||
* 设置 `K8S_RELEASE` 为要构建文档的版本。
|
||
例如，如果您想为 Kubernetes 1.17 构建文档，请将 `K8S_RELEASE` 设置为 1.17。
|
||
|
||
例如：
|
||
|
||
```
|
||
export K8S_WEBROOT=$(GOPATH)/src/github.com/<your-username>/website
|
||
export K8S_ROOT=$(GOPATH)/src/k8s.io/kubernetes
|
||
export K8S_RELEASE=1.17
|
||
```
|
||
|
||
<!--
|
||
## Creating a versioned directory
|
||
|
||
The `createversiondirs` build target creates a versioned directory
|
||
and copies the kubectl reference configuration files to the versioned directory.
|
||
The versioned directory name follows the pattern of `v<major>_<minor>`.
|
||
|
||
In the `<rdocs-base>` directory, run the following build target:
|
||
|
||
```shell
|
||
cd <rdocs-base>
|
||
make createversiondirs
|
||
```
|
||
-->
|
||
## 创建版本目录
|
||
|
||
构建目标 `createversiondirs` 会生成一个版本目录并将 kubectl 参考配置文件复制到该目录中。
|
||
版本目录的名字模式为 `v<major>_<minor>`。
|
||
|
||
在 `<rdocs-base>` 目录下，执行下面的命令：
|
||
|
||
```shell
|
||
cd <rdocs-base>
|
||
make createversiondirs
|
||
```
|
||
|
||
<!--
|
||
## Checking out a branch in k8s.io/kubernetes
|
||
|
||
In your local <k8s-base> repository, checkout the branch that has
|
||
the version of Kubernetes that you want to document. For example, if you want
|
||
to generate docs for Kubernetes 1.15, checkout the release-1.15 branch. Make sure
|
||
you local branch is up to date.
|
||
-->
|
||
## 从 kubernetes/kubernetes 检出一个分支
|
||
|
||
在本地 `<k8s-base>` 仓库中，检出你想要生成文档的、包含 Kubernetes 版本的分支。
|
||
例如，如果希望为 Kubernetes 1.17 版本生成文档，请检出 `v1.17.0` 标记。
|
||
确保本地分支是最新的。
|
||
|
||
```shell
|
||
cd <k8s-base>
|
||
git checkout v1.17.0
|
||
git pull https://github.com/kubernetes/kubernetes v1.17.0
|
||
```
|
||
|
||
<!--
|
||
## Running the doc generation code
|
||
|
||
In your local kubernetes-incubator/reference-docs repository, build and run the
|
||
kubectl command reference generation code. You might need to run the command as root:
|
||
-->
|
||
## 运行文档生成代码
|
||
|
||
在本地的 `<rdocs-base>` 目录下，运行 `copycli` 构建目标。此命令以 `root` 账号运行：
|
||
|
||
```shell
|
||
cd <rdocs-base>
|
||
make copycli
|
||
```
|
||
|
||
<!--
|
||
The `copycli` command will clean the staging directories, generate the kubectl command files,
|
||
and copy the collated kubectl reference HTML page and assets to `<web-base>`.
|
||
-->
|
||
`copycli` 命令将清理暂存目录，生成 kubectl 命令文件，并将整理后的 kubectl 参考 HTML 页面和
|
||
文件复制到 `<web-base>`。
|
||
|
||
<!--
|
||
## Locate the generated files
|
||
|
||
Verify that these two files have been generated:
|
||
-->
|
||
## 找到生成的文件
|
||
|
||
验证是否已生成以下两个文件：
|
||
|
||
```shell
|
||
[ -e "<rdocs-base>/gen-kubectldocs/generators/build/index.html" ] && echo "index.html built" || echo "no index.html"
|
||
[ -e "<rdocs-base>/gen-kubectldocs/generators/build/navData.js" ] && echo "navData.js built" || echo "no navData.js"
|
||
```
|
||
|
||
<!--
|
||
## Locate the copied files
|
||
|
||
Verify that all generated files have been copied to your `<web-base>`:
|
||
-->
|
||
## 找到复制的文件
|
||
|
||
确认所有生成的文件都已复制到你的 `<web-base>`：
|
||
|
||
```shell
|
||
cd <web-base>
|
||
git status
|
||
```
|
||
|
||
<!-- The output should include the modified files: -->
|
||
输出应包括修改后的文件：
|
||
|
||
```
|
||
static/docs/reference/generated/kubectl/kubectl-commands.html
|
||
static/docs/reference/generated/kubectl/navData.js
|
||
```
|
||
|
||
<!-- Additionally, the output might show the modified files: -->
|
||
|
||
此外，输出可能还包含：
|
||
|
||
```
|
||
static/docs/reference/generated/kubectl/scroll.js
|
||
static/docs/reference/generated/kubectl/stylesheet.css
|
||
static/docs/reference/generated/kubectl/tabvisibility.js
|
||
static/docs/reference/generated/kubectl/node_modules/bootstrap/dist/css/bootstrap.min.css
|
||
static/docs/reference/generated/kubectl/node_modules/highlight.js/styles/default.css
|
||
static/docs/reference/generated/kubectl/node_modules/jquery.scrollto/jquery.scrollTo.min.js
|
||
static/docs/reference/generated/kubectl/node_modules/jquery/dist/jquery.min.js
|
||
static/docs/reference/generated/kubectl/node_modules/font-awesome/css/font-awesome.min.css
|
||
```
|
||
|
||
<!--
|
||
## Locally test the documentation
|
||
|
||
Build the Kubernetes documentation in your local `<web-base>`.
|
||
-->
|
||
## 在本地测试文档
|
||
|
||
在本地 `<web-base>` 中构建 Kubernetes 文档。
|
||
|
||
```shell
|
||
cd <web-base>
|
||
git submodule update --init --recursive --depth 1 # if not already done
|
||
make container-serve
|
||
```
|
||
|
||
<!-- View the [local preview](https://localhost:1313/docs/reference/generated/kubectl/kubectl-commands/). -->
|
||
查看[本地预览](https://localhost:1313/docs/reference/generated/kubectl/kubectl-commands/)。
|
||
|
||
<!--
|
||
## Adding and committing changes in kubernetes/website
|
||
|
||
Run `git add` and `git commit` to commit the files.
|
||
-->
|
||
## 在 kubernetes/website 中添加和提交更改
|
||
|
||
运行 `git add` 和 `git commit` 提交修改文件。
|
||
|
||
<!--
|
||
## Creating a pull request
|
||
|
||
Create a pull request to the `kubernetes/website` repository. Monitor your
|
||
pull request, and respond to review comments as needed. Continue to monitor
|
||
your pull request until it is merged.
|
||
|
||
A few minutes after your pull request is merged, your updated reference
|
||
topics will be visible in the
|
||
[published documentation](/docs/home).
|
||
-->
|
||
## 创建 PR
|
||
|
||
对 `kubernetes/website` 仓库创建 PR。跟踪你的 PR，并根据需要回应评审人的评论。
|
||
继续跟踪你的 PR，直到它被合入。
|
||
|
||
在 PR 合入的几分钟后，你更新的参考主题将出现在[已发布文档](/zh/docs/home/)中。
|
||
|
||
## {{% heading "whatsnext" %}}
|
||
|
||
<!--
|
||
* [Generating Reference Documentation Quickstart](/docs/contribute/generate-ref-docs/quickstart/)
|
||
* [Generating Reference Documentation for Kubernetes Components and Tools](/docs/contribute/generate-ref-docs/kubernetes-components/)
|
||
* [Generating Reference Documentation for the Kubernetes API](/docs/contribute/generate-ref-docs/kubernetes-api/)
|
||
-->
|
||
* [生成参考文档快速入门](/zh/docs/contribute/generate-ref-docs/quickstart/)
|
||
* [为 Kubernetes 组件和工具生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-components/)
|
||
* [为 Kubernetes API 生成参考文档](/zh/docs/contribute/generate-ref-docs/kubernetes-api/)
|
||
|