From 93e96c005c9b5011e628351887e1d4916f9084cc Mon Sep 17 00:00:00 2001
From: yuandongx <786018072@qq.com>
Date: Wed, 2 Dec 2020 16:40:34 +0800
Subject: [PATCH] sync changes.
update
20201203 update
---
content/zh/docs/reference/kubectl/overview.md | 295 +++++++++++-------
1 file changed, 190 insertions(+), 105 deletions(-)
diff --git a/content/zh/docs/reference/kubectl/overview.md b/content/zh/docs/reference/kubectl/overview.md
index 834175c5d8..4f4125e26a 100644
--- a/content/zh/docs/reference/kubectl/overview.md
+++ b/content/zh/docs/reference/kubectl/overview.md
@@ -25,14 +25,27 @@ card:
-Kubectl 是一个命令行接口，用于对 Kubernetes 集群运行命令。`kubectl` 在 $HOME/.kube 目录中寻找一个名为 config 的文件。您可以通过设置环境变量 KUBECONFIG 或设置 [`--kubeconfig`](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 参数指定其它 [kubeconfig](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 文件。
+你可以使用 Kubectl 命令行工具管理 Kubernetes 集群。
+`kubectl` 在 `$HOME/.kube` 目录中查找一个名为 `config` 的配置文件。
+你可以通过设置 KUBECONFIG 环境变量或设置 [`--kubeconfig`](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
+参数来指定其它 [kubeconfig](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 文件。
-本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。有关每个命令的详细信息，包括所有受支持的参数和子命令，请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。有关安装说明，请参见 [安装 kubectl](/zh/docs/tasks/tools/install-kubectl/) 。
+本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。
+有关每个命令的详细信息，包括所有受支持的参数和子命令，
+请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。
+有关安装说明，请参见[安装 kubectl](/zh/docs/tasks/tools/install-kubectl/) 。
@@ -82,7 +95,7 @@ where `command`, `TYPE`, `NAME`, and `flags` are:
* `NAME`：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息 `kubectl get pods`。
- 在对多个资源执行操作时，您可以按类型和名称指定每个资源，或指定一个或多个文件：
+ 在对多个资源执行操作时，你可以按类型和名称指定每个资源，或指定一个或多个文件：
@@ -111,7 +124,7 @@ where `command`, `TYPE`, `NAME`, and `flags` are:
* 用一个或多个文件指定资源：`-f file1 -f file2 -f file<#>`
- * [使用 YAML 而不是 JSON](/zh/docs/concepts/configuration/overview/#general-config-tips) 因为 YAML 更容易使用，特别是用于配置文件时。
+ * [使用 YAML 而不是 JSON](/docs/concepts/configuration/overview/#general-configuration-tips) 因为 YAML 更容易使用，特别是用于配置文件时。
例子：`kubectl get -f ./pod.yaml`
* `flags`: 指定可选的参数。例如，可以使用 `-s` 或 `-server` 参数指定 Kubernetes API 服务器的地址和端口。
@@ -127,7 +140,7 @@ Flags that you specify from the command line override default values and any cor
-如果您需要帮助，只需从终端窗口运行 ` kubectl help ` 即可。
+如果你需要帮助，只需从终端窗口运行 ` kubectl help ` 即可。
操作 | 语法 | 描述
-------------------- | -------------------- | --------------------
+`alpha` | `kubectl alpha SUBCOMMAND [flags]` | 列出与 alpha 特性对应的可用命令，这些特性在 Kubernetes 集群中默认情况下是不启用的。
`annotate` | kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags] | 添加或更新一个或多个资源的注解。
+`api-resources` | `kubectl api-resources [flags]` | 列出可用的 API 资源。
`api-versions` | `kubectl api-versions [flags]` | 列出可用的 API 版本。
`apply` | `kubectl apply -f FILENAME [flags]`| 从文件或 stdin 对资源应用配置更改。
`attach` | `kubectl attach POD -c CONTAINER [-i] [-t] [flags]` | 附加到正在运行的容器，查看输出流或与容器（stdin）交互。
+`auth` | `kubectl auth [flags] [options]` | 检查授权。
`autoscale` | kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags] | 自动伸缩由副本控制器管理的一组 pod。
+`certificate` | `kubectl certificate SUBCOMMAND [options]` | 修改证书资源。
`cluster-info` | `kubectl cluster-info [flags]` | 显示有关集群中主服务器和服务的端口信息。
+`completion` | `kubectl completion SHELL [options]` | 为指定的 shell （bash 或 zsh）输出 shell 补齐代码。
`config` | `kubectl config SUBCOMMAND [flags]` | 修改 kubeconfig 文件。有关详细信息，请参阅各个子命令。
+`convert` | `kubectl convert -f FILENAME [options]` | 在不同的 API 版本之间转换配置文件。配置文件可以是 YAML 或 JSON 格式。
+`cordon` | `kubectl cordon NODE [options]` | 将节点标记为不可调度。
+`cp` | `kubectl cp [options]` | 在容器之间复制文件和目录。
`create` | `kubectl create -f FILENAME [flags]` | 从文件或 stdin 创建一个或多个资源。
`delete` | kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags] | 从文件、标准输入或指定标签选择器、名称、资源选择器或资源中删除资源。
`describe` | kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags] | 显示一个或多个资源的详细状态。
`diff` | `kubectl diff -f FILENAME [flags]`| 将 live 配置和文件或标准输入做对比 (**BETA**)
+`drain` | `kubectl drain NODE [options]` | 腾空节点以准备维护。
`edit` | kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags] | 使用默认编辑器编辑和更新服务器上一个或多个资源的定义。
`exec` | `kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args...]]` | 对 pod 中的容器执行命令。
`explain` | `kubectl explain [--recursive=false] [flags]` | 获取多种资源的文档。例如 pod, node, service 等。
`expose` | kubectl expose (-f FILENAME | TYPE NAME | TYPE/NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] [flags] | 将副本控制器、服务或 pod 作为新的 Kubernetes 服务暴露。
`get` | kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sort-by=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags] | 列出一个或多个资源。
+`kustomize` | `kubectl kustomize [flags] [options]` | 列出从 kustomization.yaml 文件中的指令生成的一组 API 资源。参数必须是包含文件的目录的路径，或者是 git 存储库 URL，其路径后缀相对于存储库根目录指定了相同的路径。
`label` | kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags] | 添加或更新一个或多个资源的标签。
`logs` | `kubectl logs POD [-c CONTAINER] [--follow] [flags]` | 在 pod 中打印容器的日志。
+`options` | `kubectl options` | 全局命令行选项列表，适用于所有命令。
`patch` | kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags] | 使用策略合并 patch 程序更新资源的一个或多个字段。
+`plugin` | `kubectl plugin [flags] [options]` | 提供用于与插件交互的实用程序。
`port-forward` | `kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]` | 将一个或多个本地端口转发到一个 pod。
`proxy` | `kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] [flags]` | 运行 Kubernetes API 服务器的代理。
`replace` | `kubectl replace -f FILENAME` | 从文件或标准输入中替换资源。
-`rolling-update` | kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) [flags] | 通过逐步替换指定的副本控制器及其 pod 来执行滚动更新。
+`rollout` | `kubectl rollout SUBCOMMAND [options]` | 管理资源的部署。有效的资源类型包括：Deployments, DaemonSets 和 StatefulSets。
`run` | kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server | client | none] [--overrides=inline-json] [flags] | 在集群上运行指定的镜像。
`scale` | kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags] | 更新指定副本控制器的大小。
-`stop` | `kubectl stop` | 不推荐：相反，请参阅 kubectl delete。
+`set` | `kubectl set SUBCOMMAND [options]` | 配置应用程序资源。
+`taint` | `kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N [options]` | 更新一个或多个节点上的污点。
+`top` | `kubectl top [flags] [options]` | 显示资源（CPU/内存/存储）的使用情况。
+`uncordon` | `kubectl uncordon NODE [options]` | 将节点标记为可调度。
`version` | `kubectl version [--client] [flags]` | 显示运行在客户端和服务器上的 Kubernetes 版本。
+`wait` | kubectl wait ([-f FILENAME] | resource.group/resource.name | resource.group [(-l label | --all)]) [--for=delete|--for condition=available] [options] | 实验性：等待一种或多种资源的特定条件。
-记住：有关命令操作的更多信息，请参阅 [kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。
+了解更多有关命令操作的信息，请参阅 [kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。
(以下输出可以通过 `kubectl api-resources` 获取，内容以 Kubernetes 1.19.1 版本为准。)
@@ -351,7 +396,7 @@ The following table includes a list of all the supported resource types and thei
## 输出选项
有关如何格式化或排序某些命令的输出的信息，请使用以下部分。有关哪些命令支持各种输出选项的详细信息，请参阅[kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。
@@ -419,7 +464,8 @@ kubectl get pod web-pod-13je7 -o yaml
```
请记住：有关每个命令支持哪种输出格式的详细信息，请参阅 [kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。
@@ -431,7 +477,7 @@ Remember: See the [kubectl](/docs/user-guide/kubectl/) reference documentation f
-要定义自定义列并仅将所需的详细信息输出到表中，可以使用该 custom-columns 选项。您可以选择内联定义自定义列或使用模板文件：`-o=custom-columns=` 或 `-o=custom-columns-file=`。
+要定义自定义列并仅将所需的详细信息输出到表中，可以使用该 custom-columns 选项。你可以选择内联定义自定义列或使用模板文件：`-o=custom-columns=` 或 `-o=custom-columns-file=`。
-运行任何一个命令的结果是:
+运行任何一个命令的结果类似于:
```shell
NAME RSRC
@@ -491,10 +537,10 @@ This allows for consistent human-readable output across clients used against the
通过让服务器封装打印的细节，这允许在针对同一集群使用的客户端之间提供一致的人类可读输出。
-默认情况下，此功能在 `kubectl` 1.11 及更高版本中启用。要禁用它，请将该 `--server-print=false` 参数添加到 `kubectl get` 命令中。
+此功能默认启用。要禁用它，请将该 `--server-print=false` 参数添加到 `kubectl get` 命令中。
-输出如下：
+输出类似于：
```shell
-NAME READY STATUS RESTARTS AGE
-pod-name 1/1 Running 0 1m
+NAME AGE
+pod-name 1m
```
-使用以下示例集来帮助您熟悉运行常用 kubectl 操作：
+使用以下示例集来帮助你熟悉运行常用 kubectl 操作：
```shell
@@ -651,7 +703,7 @@ kubectl describe pods/
kubectl describe pods
# 描述所有的 pod，不包括未初始化的 pod
-kubectl describe pods --include-uninitialized=false
+kubectl describe pods
```
{{< note >}}
@@ -668,7 +720,7 @@ command retrieves not only the information about the node, but also a summary of
the pods running on it, the events generated for the node etc.
-->
`kubectl get` 命令通常用于检索同一资源类型的一个或多个资源。
-它具有丰富的参数，允许您使用 `-o` 或 `--output` 参数自定义输出格式。您可以指定 `-w` 或 `--watch` 参数以开始观察特定对象的更新。
+它具有丰富的参数，允许你使用 `-o` 或 `--output` 参数自定义输出格式。你可以指定 `-w` 或 `--watch` 参数以开始观察特定对象的更新。
`kubectl describe` 命令更侧重于描述指定资源的许多相关方面。它可以调用对 `API 服务器` 的多个 API 调用来为用户构建视图。
例如，该 `kubectl describe node` 命令不仅检索有关节点的信息，还检索在其上运行的 pod 的摘要，为节点生成的事件等。
@@ -680,21 +732,25 @@ the pods running on it, the events generated for the node etc.
`kubectl delete` - 从文件、stdin 或指定标签选择器、名称、资源选择器或资源中删除资源。
```shell
# 使用 pod.yaml 文件中指定的类型和名称删除 pod。
kubectl delete -f pod.yaml
-# 删除标签名= 的所有 pod 和服务。
-kubectl delete pods,services -l name=
-
-# 删除所有具有标签名称= 的 pod 和服务，包括未初始化的那些。
-kubectl delete pods,services -l name= --include-uninitialized
+# 删除所有带有 '=' 标签的 Pod 和服务。
+kubectl delete pods,services -l =
# 删除所有 pod，包括未初始化的 pod。
kubectl delete pods --all
@@ -707,19 +763,24 @@ kubectl delete pods --all
```shell
# 从 pod 中获取运行 'date' 的输出。默认情况下，输出来自第一个容器。
-kubectl exec date
+kubectl exec -- date
# 运行输出 'date' 获取在容器的 中 pod 的输出。
-kubectl exec -c date
+kubectl exec -c -- date
# 获取一个交互 TTY 并运行 /bin/bash 。默认情况下，输出来自第一个容器。
-kubectl exec -ti /bin/bash
+kubectl exec -ti -- /bin/bash
```
```shell
@@ -749,26 +813,28 @@ kubectl logs -f
-使用以下示例来帮助您熟悉编写和使用 `kubectl` 插件：
+使用以下示例来帮助你熟悉编写和使用 `kubectl` 插件：
@@ -776,44 +842,51 @@ kubectl hello
# 用任何语言创建一个简单的插件，并为生成的可执行文件命名
# 以前缀 "kubectl-" 开始
cat ./kubectl-hello
-#!/bin/bash
+```
+
+```shell
+#!/bin/sh
# 这个插件打印单词 "hello world"
echo "hello world"
-
-# 我们的插件写好了，让我们把它变成可执行的
-sudo chmod +x ./kubectl-hello
+```
+这个插件写好了，把它变成可执行的：
+```bash
+sudo chmod a+x ./kubectl-hello
# 并将其移动到路径中的某个位置
sudo mv ./kubectl-hello /usr/local/bin
+sudo chown root:root /usr/local/bin
-# 我们现在已经创建并"安装"了一个 kubectl 插件。
-# 我们可以开始使用我们的插件，从 kubectl 调用它，就像它是一个常规命令一样
+# 你现在已经创建并"安装了"一个 kubectl 插件。
+# 你可以开始使用这个插件，从 kubectl 调用它，就像它是一个常规命令一样
kubectl hello
```
```
hello world
```
-```
-# 我们可以"卸载"一个插件，只需从我们的路径中删除它
+```shell
+# 你可以"卸载"一个插件，只需从你的路径中删除它
sudo rm /usr/local/bin/kubectl-hello
```
-为了查看可用的所有 `kubectl` 插件，我们可以使用 `kubectl plugin list` 子命令：
+为了查看可用的所有 `kubectl` 插件，你可以使用 `kubectl plugin list` 子命令：
```shell
kubectl plugin list
```
+输出类似于：
```
-以下 kubectl-适配 的插件是可用的：
+The following kubectl-compatible plugins are available:
/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo
/usr/local/bin/kubectl-bar
```
-```
-# 这个指令也可以警告我们哪些插件
-# 被运行，或是被其它插件覆盖了
-# 例如
-sudo chmod -x /usr/local/bin/kubectl-foo
+`kubectl plugin list`指令也可以向你告警哪些插件被运行，或是被其它插件覆盖了,例如:
+```shell
+sudo chmod -x /usr/local/bin/kubectl-foo # 删除执行权限
kubectl plugin list
```
```
-以下 kubectl-适配 的插件是可用的：
+The following kubectl-compatible plugins are available:
/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo
- - 警告: /usr/local/bin/kubectl-foo 被识别为一个插件，但是它并不可以执行
+ - warning: /usr/local/bin/kubectl-foo identified as a plugin, but it is not executable
/usr/local/bin/kubectl-bar
-错误: 发现了一个插件警告
+error: one plugin warning was found
```
-我们可以将插件视为在现有 kubectl 命令之上构建更复杂功能的一种方法：
+你可以将插件视为在现有 kubectl 命令之上构建更复杂功能的一种方法：
+```shell
cat ./kubectl-whoami
+```
+
+
+接下来的几个示例假设你已经将 `kubectl-whoami` 设置为以下内容:
+
+
-
```shell
-cat ./kubectl-whoami
#!/bin/bash
-# 这个插件借用 `kubectl config` 指令来输出
-# 当前用户的信息，基于当前指定的 context
-kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ .context.user }}{{ end }}{{ end }}'
+#这个插件利用 `kubectl config` 命令基于当前所选上下文输出当前用户的信息
+kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ printf "%s\n" .context.user }}{{ end }}{{ end }}'
```
-运行上面的插件为我们提供了一个输出，其中包含我们 KUBECONFIG 文件中当前所选定上下文对应的用户：
+运行以上命令将为你提供一个输出，其中包含 KUBECONFIG 文件中当前上下文的用户:
-
```shell
+#!/bin/bash
# 使文件成为可执行的
sudo chmod +x ./kubectl-whoami
-# 然后移动到我们的路径中
+# 然后移动到你的路径中
sudo mv ./kubectl-whoami /usr/local/bin
kubectl whoami
@@ -935,6 +1016,10 @@ To find out more about plugins, take a look at the [example cli plugin](https://
-开始使用 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 命令。
+* 开始使用 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 命令。
+
+* 查看更多[示例 cli 插件](https://github.com/kubernetes/sample-cli-plugin)。