From 77168085f2b1ae3a84aa59ca9e488e23e049dfaf Mon Sep 17 00:00:00 2001
From: LiuDui <1693291525@qq.com>
Date: Sun, 9 Jun 2019 21:15:05 +0800
Subject: [PATCH] ZH-trans: add overview.md (#13234)
* ZH-trabs
* Update overview.md
* Update overview.md
* Update overview.md
* Update overview.md
* Update overview.md
* Update overview.md
* Update overview.md
---
content/zh/docs/reference/kubectl/overview.md | 819 ++++++++++++++++++
1 file changed, 819 insertions(+)
create mode 100644 content/zh/docs/reference/kubectl/overview.md
diff --git a/content/zh/docs/reference/kubectl/overview.md b/content/zh/docs/reference/kubectl/overview.md
new file mode 100644
index 0000000000..5150f327da
--- /dev/null
+++ b/content/zh/docs/reference/kubectl/overview.md
@@ -0,0 +1,819 @@
+---
+reviewers:
+- bgrant0607
+- hw-qiaolei
+title: kubectl 概述
+content_template: templates/concept
+weight: 20
+---
+
+
+
+{{% capture overview %}}
+
+
+Kubectl 是一个命令行接口，用于对 Kubernetes 集群运行命令。
+本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。有关每个命令的详细信息，包括所有受支持的参数和子命令，请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。有关安装说明，请参见[安装 kubectl](/docs/tasks/kubectl/install/)。
+
+{{% /capture %}}
+
+{{% capture body %}}
+
+
+
+## 语法
+
+
+使用以下语法 `kubectl` 从终端窗口运行命令：
+
+```shell
+kubectl [command] [TYPE] [NAME] [flags]
+```
+
+
+其中 `command`、`TYPE`、`NAME` 和 `flags` 分别是：
+
+
+
+* `command`：指定要对一个或多个资源执行的操作，例如 `create`、`get`、`describe`、`delete`。
+
+* `TYPE`：指定[资源类型](#resource-types)。资源类型不区分大小写，可以指定单数、复数或缩写形式。例如，以下命令输出相同的结果:
+
+ ```shell
+ $ kubectl get pod pod1
+ $ kubectl get pods pod1
+ $ kubectl get po pod1
+ ```
+
+
+
+* `NAME`：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息 `$ kubectl get pods`。
+
+ 在对多个资源执行操作时，您可以按类型和名称指定每个资源，或指定一个或多个文件：
+
+
+
+ * 要按类型和名称指定资源：
+
+ * 要对所有类型相同的资源进行分组，请执行以下操作：`TYPE1 name1 name2 name<#>`。
+ 例子：`$ kubectl get pod example-pod1 example-pod2`
+
+ * 分别指定多个资源类型：`TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>`。
+ 例子：`$ kubectl get pod/example-pod1 replicationcontroller/example-rc1`
+
+ * 用一个或多个文件指定资源：`-f file1 -f file2 -f file<#>`
+
+ * [使用 YAML 而不是 JSON](/docs/concepts/configuration/overview/#general-config-tips) 因为 YAML 更容易使用，特别是用于配置文件时。
+ 例子：`$ kubectl get pod -f ./pod.yaml`
+
+* `flags`: 指定可选的参数。例如，可以使用 `-s` 或 `-server` 参数指定 Kubernetes API 服务器的地址和端口。
+
+{{< caution >}}
+
+
+从命令行指定的参数会覆盖默认值和任何相应的环境变量。
+{{< /caution >}}
+
+
+如果您需要帮助，只需从终端窗口运行 ` kubectl help ` 即可。
+
+
+
+## 操作
+
+
+下表包含所有 kubectl 操作的简短描述和普通语法：
+
+
+
+
+
+操作 | 语法 | 描述
+-------------------- | -------------------- | --------------------
+`annotate` | `kubectl annotate (-f FILENAME \| TYPE NAME \| TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]` | 添加或更新一个或多个资源的注解。
+`api-versions` | `kubectl api-versions [flags]` | 列出可用的 API 版本。
+`apply` | `kubectl apply -f FILENAME [flags]`| 从文件或 stdin 对资源应用配置更改。
+`attach` | `kubectl attach POD -c CONTAINER [-i] [-t] [flags]` | 附加到正在运行的容器，查看输出流或与容器（stdin）交互。
+`autoscale` | `kubectl autoscale (-f FILENAME \| TYPE NAME \| TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]` | 自动伸缩由副本控制器管理的一组 pod。
+`cluster-info` | `kubectl cluster-info [flags]` | 显示有关集群中主服务器和服务的端口信息。
+`config` | `kubectl config SUBCOMMAND [flags]` | 修改 kubeconfig 文件。有关详细信息，请参阅各个子命令。
+`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]` | 显示一个或多个资源的详细状态。
+`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 [--include-extended-apis=true] [--recursive=false] [flags]` | 获取各种资源的文档。例如 pod、节点、服务等。
+`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]` | 列出一个或多个资源。
+`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 中打印容器的日志。
+`patch` | `kubectl patch (-f FILENAME \| TYPE NAME \| TYPE/NAME) --patch PATCH [flags]` | 使用策略合并 patch 程序更新资源的一个或多个字段。
+`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 来执行滚动更新。
+`run` | `kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--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。
+`version` | `kubectl version [--client] [flags]` | 显示运行在客户端和服务器上的 Kubernetes 版本。
+
+
+
+
+记住：有关命令操作的更多信息，请参阅 [kubectl](/docs/user-guide/kubectl/) 参考文档。
+
+
+
+## 资源类型
+
+
+下表列出所有受支持的资源类型及其缩写别名:
+
+
+
+资源类型 | 缩写别名
+-------------------- | --------------------
+`apiservices` |
+`certificatesigningrequests` |`csr`
+`clusters` |
+`clusterrolebindings` |
+`clusterroles` |
+`componentstatuses` |`cs`
+`configmaps` |`cm`
+`controllerrevisions` |
+`cronjobs` |
+`customresourcedefinition` |`crd`
+`daemonsets` |`ds`
+`deployments` |`deploy`
+`endpoints` |`ep`
+`events` |`ev`
+`horizontalpodautoscalers` |`hpa`
+`ingresses` |`ing`
+`jobs` |
+`limitranges` |`limits`
+`namespaces` |`ns`
+`networkpolicies` |`netpol`
+`nodes` |`no`
+`persistentvolumeclaims` |`pvc`
+`persistentvolumes` |`pv`
+`poddisruptionbudget` |`pdb`
+`podpreset` |
+`pods` |`po`
+`podsecuritypolicies` |`psp`
+`podtemplates` |
+`replicasets` |`rs`
+`replicationcontrollers` |`rc`
+`resourcequotas` |`quota`
+`rolebindings` |
+`roles` |
+`secrets` |
+`serviceaccounts` |`sa`
+`services` |`svc`
+`statefulsets` |
+`storageclasses` |
+
+<--
+## Output options
+-->
+
+## 输出选项
+
+
+有关如何格式化或排序某些命令的输出的信息，请使用以下部分。有关哪些命令支持各种输出选项的详细信息，请参阅kubectl参考文档。
+通过以下部分了解如何格式化或排序某些命令的输出。有关哪些命令支持各种输出选项的详细信息，请参阅 [kubectl](/docs/user-guide/kubectl/) 参考文档。
+
+
+
+### 格式化输出
+
+
+所有 `kubectl` 命令的默认输出格式都是人类可读的纯文本格式。要以特定格式向终端窗口输出详细信息，可以将 `-o` 或 `--output` 参数添加到受支持的 `kubectl` 命令中。
+
+
+
+#### 语法
+
+```shell
+kubectl [command] [TYPE] [NAME] -o=
+```
+
+
+根据 `kubectl` 操作，支持以下输出格式：
+
+
+
+
+
+输出格式 | 描述
+--------------| -----------
+`-o=custom-columns=` | 使用逗号分隔的[自定义列](#custom-columns)列表打印表。
+`-o=custom-columns-file=` | 使用 `` 文件中的[自定义列](#custom-columns)模板打印表。
+`-o=json` | 输出 JSON 格式的 API 对象。
+`-o=jsonpath-file=` | 打印 `` 文件中 [jsonpath](/docs/reference/kubectl/jsonpath/) 表达式定义的字段。
+`-o=jsonpath-file=` | 打印文件中 [jsonpath](/docs/reference/kubectl/jsonpath/) 表达式定义的字段 ``。
+`-o=name` | 仅打印资源名称而不打印任何其他内容。
+`-o=wide` | 以纯文本格式输出，包含任何附加信息。对于 pod 包含节点名。
+`-o=yaml` | 输出 YAML 格式的 API 对象。
+
+
+
+##### 示例
+
+
+在此示例中，以下命令将单个 pod 的详细信息输出为 YAML 格式的对象：
+
+```shell
+$ kubectl get pod web-pod-13je7 -o=yaml
+```
+
+
+请记住：有关每个命令支持哪种输出格式的详细信息，请参阅 [kubectl](/docs/user-guide/kubectl/) 参考文档。
+
+
+
+#### 自定义列
+
+
+要定义自定义列并仅将所需的详细信息输出到表中，可以使用该 custom-columns 选项。您可以选择内联定义自定义列或使用模板文件：`-o=custom-columns=` 或 `-o=custom-columns-file=`。
+
+
+
+##### 示例
+
+
+内联：
+
+```shell
+$ kubectl get pods -o=custom-columns=NAME:.metadata.name,RSRC:.metadata.resourceVersion
+```
+
+
+模板文件：
+
+```shell
+$ kubectl get pods -o=custom-columns-file=template.txt
+```
+
+
+其中，`template.txt` 文件包含：
+
+```
+NAME RSRC
+metadata.name metadata.resourceVersion
+```
+
+
+运行任何一个命令的结果是:
+
+```shell
+NAME RSRC
+submit-queue 610995
+```
+
+
+
+#### Server-side 列
+
+
+`kubectl` 支持从服务器接收关于对象的特定列信息。
+这意味着对于任何给定的资源，服务器将返回与该资源相关的列和行，以便客户端打印。
+通过让服务器封装打印的细节，这允许在针对同一集群使用的客户端之间提供一致的人类可读输出。
+
+
+默认情况下，此功能在 `kubectl` 1.11 及更高版本中启用。要禁用它，请将该 `--server-print=false` 参数添加到 `kubectl get` 命令中。
+
+
+
+##### 例子：
+
+
+要打印有关 pod 状态的信息，请使用如下命令：
+
+```shell
+kubectl get pods --server-print=false
+```
+
+
+输出如下：
+
+```shell
+NAME READY STATUS RESTARTS AGE
+pod-name 1/1 Running 0 1m
+```
+
+
+
+### 排序列表对象
+
+
+要将对象排序后输出到终端窗口，可以将 `--sort-by` 参数添加到支持的 `kubectl` 命令。通过使用 `--sort-by` 参数指定任何数字或字符串字段来对对象进行排序。要指定字段，请使用 [jsonpath](/docs/reference/kubectl/jsonpath/) 表达式。
+
+
+
+#### 语法
+
+```shell
+kubectl [command] [TYPE] [NAME] --sort-by=
+```
+
+
+
+##### 示例
+
+
+要打印按名称排序的 pod 列表，请运行：
+
+```shell
+$ kubectl get pods --sort-by=.metadata.name
+```
+
+
+
+## 示例：常见操作
+
+
+使用以下示例集来帮助您熟悉运行常用 kubectl 操作：
+
+
+
+`kubectl create` - 从文件或标准输出创建资源。
+
+
+
+```shell
+// 使用 example-service.yaml 中的定义创建一个服务。
+$ kubectl create -f example-service.yaml
+
+// 使用 example-controller.yaml 中的定义创建副本控制器。
+$ kubectl create -f example-controller.yaml
+
+// 创建在目录中的任何 .yaml、.yml 或 .json 文件中定义的对象。
+$ kubectl create -f
+```
+
+
+`kubectl get` - 列出一个或多个资源。
+
+
+
+```shell
+// 以纯文本输出格式列出所有 pod。
+$ kubectl get pods
+
+// 以纯文本输出格式列出所有 pod，并包含附加信息(如节点名)。
+$ kubectl get pods -o wide
+
+// 以纯文本输出格式列出具有指定名称的副本控制器。提示：您可以使用别名 'rc' 缩短和替换 'replicationcontroller' 资源类型。
+$ kubectl get replicationcontroller
+
+// 以纯文本输出格式列出所有副本控制器和服务。
+$ kubectl get rc,services
+
+// 以纯文本输出格式列出所有守护程序集，包括未初始化的守护程序集。
+$ kubectl get ds --include-uninitialized
+
+// 列出在节点 server01 上运行的所有 pod
+$ kubectl get pods --field-selector=spec.nodeName=server01
+
+// 以纯文本输出格式列出所有 pod，将打印细节委托给服务器
+$ kubectl get pods --experimental-server-print
+```
+
+
+`kubectl describe` - 显示一个或多个资源的详细状态，默认情况下包括未初始化的资源。
+
+
+
+```shell
+// 显示名称为 的节点的详细信息。
+$ kubectl describe nodes
+
+// 显示名为 的 pod 的详细信息。
+$ kubectl describe pods/
+
+// 显示由名为 的副本控制器管理的所有 pod 的详细信息。
+// 记住：副本控制器创建的任何 pod 都以复制控制器的名称为前缀。
+$ kubectl describe pods
+
+// 描述所有的 pod，不包括未初始化的 pod
+$ kubectl describe pods --include-uninitialized=false
+```
+
+{{< note >}}
+
+
+`kubectl get` 命令通常用于检索同一资源类型的一个或多个资源。
+它具有丰富的参数，允许您使用 `-o` 或 `--output` 参数自定义输出格式。您可以指定 `-w` 或 `--watch` 参数以开始观察特定对象的更新。
+`kubectl describe` 命令更侧重于描述指定资源的许多相关方面。它可以调用对 `API 服务器` 的多个 API 调用来为用户构建视图。
+例如，该 `kubectl describe node` 命令不仅检索有关节点的信息，还检索在其上运行的 pod 的摘要，为节点生成的事件等。
+
+{{< /note >}}
+
+
+`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，包括未初始化的 pod。
+$ kubectl delete pods --all
+```
+
+
+`kubectl exec` - 对 pod 中的容器执行命令。
+
+
+
+```shell
+// 从 pod 中获取运行 'date' 的输出。默认情况下，输出来自第一个容器。
+$ kubectl exec date
+
+// 运行输出 'date' 获取在容器的 中 pod 的输出。
+$ kubectl exec -c date
+
+// 获取一个交互 TTY 并运行 /bin/bash 。默认情况下，输出来自第一个容器。
+$ kubectl exec -ti /bin/bash
+```
+
+
+`kubectl logs` - 打印 Pod 中容器的日志。
+
+
+
+```shell
+// 从 pod 返回日志快照。
+$ kubectl logs
+
+// 从 pod 开始流式传输日志。这类似于 'tail -f' Linux 命令。
+$ kubectl logs -f
+```
+
+
+
+## 示例：创建和使用插件
+
+
+使用以下示例来帮助您熟悉编写和使用 `kubectl` 插件：
+
+
+
+```shell
+// 用任何语言创建一个简单的插件，并为生成的可执行文件命名
+// 以前缀 "kubectl-" 开始
+$ cat ./kubectl-hello
+#!/bin/bash
+
+# 这个插件打印单词 "hello world"
+echo "hello world"
+
+// 我们的插件写好了，让我们把它变成可执行的
+$ sudo chmod +x ./kubectl-hello
+
+// 并将其移动到路径中的某个位置
+$ sudo mv ./kubectl-hello /usr/local/bin
+
+// 我们现在已经创建并"安装"了一个 kubectl 插件。
+// 我们可以开始使用我们的插件，从 kubectl 调用它，就像它是一个常规命令一样
+$ kubectl hello
+hello world
+
+// 我们可以"卸载"一个插件，只需从我们的路径中删除它
+$ sudo rm /usr/local/bin/kubectl-hello
+```
+
+
+为了查看可用的所有 `kubectl` 插件，我们可以使用 `kubectl plugin list` 子命令：
+
+
+
+```shell
+$ kubectl plugin list
+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
+The following kubectl-compatible plugins are available:
+
+/usr/local/bin/kubectl-hello
+/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 命令之上构建更复杂功能的一种方式:
+
+
+
+```shell
+$ cat ./kubectl-whoami
+#!/bin/bash
+
+# 这个插件使用 'kubectl config' 命令来输出
+# 关于当前用户的信息，基于当前选择的上下文
+kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ .context.user }}{{ end }}{{ end }}'
+```
+
+
+运行上面的插件可以得到一个输出，其中包含当前在 KUBECONFIG 文件中选择的上下文的用户:
+
+```shell
+// 使文件可执行
+$ sudo chmod +x ./kubectl-whoami
+
+// 把它移到我们的路径上
+$ sudo mv ./kubectl-whoami /usr/local/bin
+
+$ kubectl whoami
+Current user: plugins-user
+```
+
+
+
+
+
+要了解关于插件的更多信息，请查看[示例 cli 插件](https://github.com/kubernetes/sample-cli-plugin)。
+
+{{% /capture %}}
+
+{{% capture whatsnext %}}
+
+
+开始使用 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 命令。
+
+{{% /capture %}}