Skip to content

Commit e4c4c8c

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #46335 from my-git9/pt-1091
[zh-cn] sync kubectl/_index kubectl quick-reference reference/_index
2 parents db0ac35 + bd86f84 commit e4c4c8c

File tree

4 files changed

+74
-53
lines changed

4 files changed

+74
-53
lines changed

‎content/zh-cn/docs/reference/_index.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,12 @@ operator to use or manage a cluster.
140140
* [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and
141141
[kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and
142142
[kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
143-
* [kube-apiserver encryption (v1)](/docs/reference/config-api/apiserver-encryption.v1/)
144143
* [kube-apiserver event rate limit (v1alpha1)](/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
145144
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
146145
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
147146
[kubelet configuration (v1)](/docs/reference/config-api/kubelet-config.v1/)
148-
* [kubelet credential providers (v1alpha1)](/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/),
149-
[kubelet credential providers (v1beta1)](/docs/reference/config-api/kubelet-credentialprovider.v1beta1/) and
150-
[kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
151-
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
147+
* [kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
148+
* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
152149
[kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/)
153150
* [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
154151
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
@@ -164,28 +161,25 @@ operator to use or manage a cluster.
164161
尽管这些 API 对于用户或操作者使用或管理集群来说是必不可少的，
165162
它们大都没有以 RESTful 的方式在 API 服务器上公开。
166163

167-
* [kubeconfig (v1)](/zh-cn/docs/reference/config-api/kubeconfig.v1/)
168-
* [kube-apiserver 准入 (v1)](/zh-cn/docs/reference/config-api/apiserver-admission.v1/)
169-
* [kube-apiserver 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1/) 和
170-
[kube-apiserver 配置 (v1beta1)](/zh-cn/docs/reference/config-api/apiserver-config.v1beta1/) 和
171-
[kube-apiserver 配置 (v1)](/zh-cn/docs/reference/config-api/apiserver-config.v1/)
172-
* [kube-apiserver 加密 (v1)](/zh-cn/docs/reference/config-api/apiserver-encryption.v1/)
173-
* [kube-apiserver 事件速率限制 (v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
174-
* [kubelet 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/kubelet-config.v1alpha1/)、
175-
[kubelet 配置 (v1beta1)](/zh-cn/docs/reference/config-api/kubelet-config.v1beta1/) 和
176-
[kubelet 配置 (v1)](/zh-cn/docs/reference/config-api/kubelet-config.v1/)
177-
* [kubelet 凭据驱动 (v1alpha1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/)、
178-
[kubelet 凭据驱动 (v1beta1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1beta1/) 和
179-
[kubelet 凭据驱动 (v1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1/)
180-
[kube-scheduler 配置 (v1beta3)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1beta3/) 和
181-
[kube-scheduler 配置 (v1)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1/)
182-
* [kube-controller-manager 配置 (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
183-
* [kube-proxy 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/kube-proxy-config.v1alpha1/)
164+
* [kubeconfig（v1）](/zh-cn/docs/reference/config-api/kubeconfig.v1/)
165+
* [kube-apiserver 准入（v1）](/zh-cn/docs/reference/config-api/apiserver-admission.v1/)
166+
* [kube-apiserver 配置（v1alpha1）](/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1/) 和
167+
[kube-apiserver 配置（v1beta1）](/zh-cn/docs/reference/config-api/apiserver-config.v1beta1/) 和
168+
[kube-apiserver 配置（v1）](/zh-cn/docs/reference/config-api/apiserver-config.v1/)
169+
* [kube-apiserver 事件速率限制（v1alpha1）](/zh-cn/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
170+
* [kubelet 配置（v1alpha1）](/zh-cn/docs/reference/config-api/kubelet-config.v1alpha1/)、
171+
[kubelet 配置（v1beta1）](/zh-cn/docs/reference/config-api/kubelet-config.v1beta1/) 和
172+
[kubelet 配置（v1）](/zh-cn/docs/reference/config-api/kubelet-config.v1/)
173+
* [kubelet 凭据驱动（v1）](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1/)
174+
* [kube-scheduler 配置（v1）](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1/) 和
175+
[kube-scheduler 配置（v1beta3）](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1beta3/)
176+
* [kube-controller-manager 配置（v1alpha1）](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
177+
* [kube-proxy 配置（v1alpha1）](/zh-cn/docs/reference/config-api/kube-proxy-config.v1alpha1/)
184178
* [`audit.k8s.io/v1` API](/zh-cn/docs/reference/config-api/apiserver-audit.v1/)
185-
* [客户端身份认证 API (v1beta1)](/zh-cn/docs/reference/config-api/client-authentication.v1beta1/) 和
186-
[客户端身份认证 API (v1)](/zh-cn/docs/reference/config-api/client-authentication.v1/)
187-
* [WebhookAdmission 配置 (v1)](/zh-cn/docs/reference/config-api/apiserver-webhookadmission.v1/)
188-
* [ImagePolicy API (v1alpha1)](/zh-cn/docs/reference/config-api/imagepolicy.v1alpha1/)
179+
* [客户端身份认证 API（v1beta1）](/zh-cn/docs/reference/config-api/client-authentication.v1beta1/) 和
180+
[客户端身份认证 API（v1）](/zh-cn/docs/reference/config-api/client-authentication.v1/)
181+
* [WebhookAdmission 配置（v1）](/zh-cn/docs/reference/config-api/apiserver-webhookadmission.v1/)
182+
* [ImagePolicy API（v1alpha1）](/zh-cn/docs/reference/config-api/imagepolicy.v1alpha1/)
189183

190184
<!--
191185
## Config API for kubeadm
@@ -212,9 +206,9 @@ by the core project:
212206

213207
这些是 Kubernetes 项目所定义的 API，但不是由核心项目实现的：
214208

215-
* [指标 API (v1beta1)](/zh-cn/docs/reference/external-api/metrics.v1beta1/)
216-
* [自定义指标 API (v1beta2)](/zh-cn/docs/reference/external-api/custom-metrics.v1beta2)
217-
* [外部指标 API (v1beta1)](/zh-cn/docs/reference/external-api/external-metrics.v1beta1)
209+
* [指标 API（v1beta1）](/zh-cn/docs/reference/external-api/metrics.v1beta1/)
210+
* [自定义指标 API（v1beta2）](/zh-cn/docs/reference/external-api/custom-metrics.v1beta2)
211+
* [外部指标 API（v1beta1）](/zh-cn/docs/reference/external-api/external-metrics.v1beta1)
218212

219213
<!--
220214
## Design Docs

‎content/zh-cn/docs/reference/kubectl/_index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,21 @@ files by setting the `KUBECONFIG` environment variable or by setting the
4343
<!--
4444
This overview covers `kubectl` syntax, describes the command operations, and provides common examples.
4545
For details about each command, including all the supported flags and subcommands, see the
46-
[kubectl](/docs/reference/generated/kubectl/kubectl-commands/) reference documentation.
46+
[kubectl](/docs/reference/kubectl/generated/kubectl/) reference documentation.
4747
-->
4848
本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。
4949
有关每个命令的详细信息，包括所有受支持的参数和子命令，
50-
请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。
50+
请参阅 [kubectl](/zh-cn/docs/reference/kubectl/generated/kubectl/) 参考文档。
5151

5252
<!--
5353
For installation instructions, see [Installing kubectl](/docs/tasks/tools/#kubectl);
54-
for a quick guide, see the [cheat sheet](/docs/reference/kubectl/cheatsheet/).
54+
for a quick guide, see the [cheat sheet](/docs/reference/kubectl/quick-reference/).
5555
If you're used to using the `docker` command-line tool,
5656
[`kubectl` for Docker Users](/docs/reference/kubectl/docker-cli-to-kubectl/)
5757
explains some equivalent commands for Kubernetes.
5858
-->
5959
有关安装说明，请参见[安装 kubectl](/zh-cn/docs/tasks/tools/#kubectl)；
60-
如需快速指南，请参见[备忘单](/zh-cn/docs/reference/kubectl/cheatsheet/)。
60+
如需快速指南，请参见[备忘单](/zh-cn/docs/reference/kubectl/quick-reference/)。
6161
如果你更习惯使用 `docker` 命令行工具，
6262
[Docker 用户的 `kubectl`](/zh-cn/docs/reference/kubectl/docker-cli-to-kubectl/)
6363
介绍了一些 Kubernetes 的等价命令。
@@ -300,14 +300,14 @@ Operation | Syntax | Description
300300
`scale` | <code>kubectl scale (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]</code> | Update the size of the specified replication controller.
301301
`set` | `kubectl set SUBCOMMAND [options]` | Configure application resources.
302302
`taint` | `kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N [options]` | Update the taints on one or more nodes.
303-
`top` | `kubectl top (POD | NODE) [flags] [options]` | Display Resource (CPU/Memory/Storage) usage.
303+
`top` | <code>kubectl top (POD &#124; NODE) [flags] [options]</code> | Display Resource (CPU/Memory/Storage) usage of pod or node.
304304
`uncordon` | `kubectl uncordon NODE [options]` | Mark node as schedulable.
305305
`version` | `kubectl version [--client] [flags]` | Display the Kubernetes version running on the client and server.
306306
`wait` | <code>kubectl wait ([-f FILENAME] &#124; resource.group/resource.name &#124; resource.group [(-l label &#124; --all)]) [--for=delete&#124;--for condition=available] [options]</code> | Experimental: Wait for a specific condition on one or many resources.
307307
-->
308308
操作 | 语法 | 描述
309309
-------------------- | -------------------- | --------------------
310-
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | 列出与 alpha 特性对应的可用命令，这些特性在 Kubernetes 集群中默认情况下是不启用的。
310+
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | 列出与 Alpha 级别特性对应的可用命令，这些特性在 Kubernetes 集群中默认情况下是不启用的。
311311
`annotate` | <code>kubectl annotate (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]</code> | 添加或更新一个或多个资源的注解。
312312
`api-resources` | `kubectl api-resources [flags]` | 列出可用的 API 资源。
313313
`api-versions` | `kubectl api-versions [flags]` | 列出可用的 API 版本。
@@ -325,7 +325,7 @@ Operation | Syntax | Description
325325
`create` | `kubectl create -f FILENAME [flags]` | 从文件或 stdin 创建一个或多个资源。
326326
`delete` | <code>kubectl delete (-f FILENAME &#124; TYPE [NAME &#124; /NAME &#124; -l label &#124; --all]) [flags]</code> | 基于文件、标准输入或通过指定标签选择器、名称、资源选择器或资源本身，删除资源。
327327
`describe` | <code>kubectl describe (-f FILENAME &#124; TYPE [NAME_PREFIX &#124; /NAME &#124; -l label]) [flags]</code> | 显示一个或多个资源的详细状态。
328-
`diff` | `kubectl diff -f FILENAME [flags]`| 在当前起作用的配置和文件或标准输之间作对比 (**BETA**)
328+
`diff` | `kubectl diff -f FILENAME [flags]`| 在当前起作用的配置和文件或标准输之间作对比（**BETA**）
329329
`drain` | `kubectl drain NODE [options]` | 腾空节点以准备维护。
330330
`edit` | <code>kubectl edit (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) [flags]</code> | 使用默认编辑器编辑和更新服务器上一个或多个资源的定义。
331331
`events` | `kubectl events` | 列举事件。
@@ -347,7 +347,7 @@ Operation | Syntax | Description
347347
`scale` | <code>kubectl scale (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]</code> | 更新指定副本控制器的大小。
348348
`set` | `kubectl set SUBCOMMAND [options]` | 配置应用资源。
349349
`taint` | `kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N [options]` | 更新一个或多个节点上的污点。
350-
`top` | `kubectl top (POD | NODE) [flags] [options]` | 显示资源（CPU、内存、存储）的使用情况。
350+
`top` | <code>kubectl top (POD &#124; NODE) [flags] [options]</code> | 显示 Pod 或节点的资源（CPU/内存/存储）使用情况。
351351
`uncordon` | `kubectl uncordon NODE [options]` | 将节点标记为可调度。
352352
`version` | `kubectl version [--client] [flags]` | 显示运行在客户端和服务器上的 Kubernetes 版本。
353353
`wait` | <code>kubectl wait ([-f FILENAME] &#124; resource.group/resource.name &#124; resource.group [(-l label &#124; --all)]) [--for=delete&#124;--for condition=available] [options]</code> | 实验特性：等待一种或多种资源的特定状况。
@@ -839,7 +839,6 @@ kubectl exec <pod-name> -c <container-name> -- date
839839
# Get an interactive TTY and run /bin/bash from pod <pod-name>. By default, output is from the first container.
840840
kubectl exec -ti <pod-name> -- /bin/bash
841841
-->
842-
843842
```shell
844843
# 从 Pod <pod-name> 中获取运行 'date' 的输出。默认情况下，输出来自第一个容器。
845844
kubectl exec <pod-name> -- date
@@ -963,6 +962,7 @@ kubectl hello
963962
```
964963
hello world
965964
```
965+
966966
<!--
967967
```shell
968968
# You can "uninstall" a plugin, by removing it from the folder in your
@@ -1089,15 +1089,15 @@ Current user: plugins-user
10891089
<!--
10901090
* Read the `kubectl` reference documentation:
10911091
* the kubectl [command reference](/docs/reference/kubectl/kubectl/)
1092-
* the [command line arguments](/docs/reference/generated/kubectl/kubectl-commands/) reference
1092+
* the [command line arguments](/docs/reference/kubectl/generated/kubectl/) reference
10931093
* Learn about [`kubectl` usage conventions](/docs/reference/kubectl/conventions/)
10941094
* Read about [JSONPath support](/docs/reference/kubectl/jsonpath/) in kubectl
10951095
* Read about how to [extend kubectl with plugins](/docs/tasks/extend-kubectl/kubectl-plugins)
10961096
* To find out more about plugins, take a look at the [example CLI plugin](https://github.com/kubernetes/sample-cli-plugin).
10971097
-->
10981098
* 阅读 `kubectl` 参考文档：
10991099
* kubectl [命令参考](/zh-cn/docs/reference/kubectl/kubectl/)
1100-
* 参考[命令行参数](/docs/reference/generated/kubectl/kubectl-commands/)
1100+
* 参考[命令行参数](/docs/reference/kubectl/generated/kubectl/)
11011101
* 学习关于 [`kubectl` 使用约定](/zh-cn/docs/reference/kubectl/conventions/)
11021102
* 阅读 kubectl 中的 [JSONPath 支持](/zh-cn/docs/reference/kubectl/jsonpath/)
11031103
* 了解如何[使用插件扩展 kubectl](/zh-cn/docs/tasks/extend-kubectl/kubectl-plugins)

‎content/zh-cn/docs/reference/kubectl/kubectl.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,18 @@ When set to false, turns off extra HTTP headers detailing invoked kubectl comman
518518
</td>
519519
</tr>
520520

521+
<tr>
522+
<td colspan="2">KUBECTL_DEBUG_CUSTOM_PROFILE</td>
523+
</tr>
524+
<tr>
525+
<td></td><td style="line-height: 130%; word-wrap: break-word;">
526+
<!--
527+
When set to true, custom flag will be enabled in kubectl debug. This flag is used to customize the pre-defined profiles.
528+
-->
529+
设置为 true 时，将在 kubectl 调试中启用自定义标志，该标志用于自定义预定义的配置文件。
530+
</td>
531+
</tr>
532+
521533
<tr>
522534
<td colspan="2">KUBECTL_EXPLAIN_OPENAPIV3</td>
523535
</tr>
@@ -543,6 +555,20 @@ When set to true, external plugins can be used as subcommands for builtin comman
543555
</td>
544556
</tr>
545557

558+
<tr>
559+
<td colspan="2">KUBECTL_PORT_FORWARD_WEBSOCKETS</td>
560+
</tr>
561+
<tr>
562+
<td></td><td style="line-height: 130%; word-wrap: break-word;">
563+
<!--
564+
When set to true, the kubectl port-forward command will attempt to stream using the websockets protocol.
565+
If the upgrade to websockets fails, the commands will fallback to use the current SPDY protocol.
566+
-->
567+
当设置为 true 时，`kubectl port-forward` 命令将尝试使用 WebSocket 协议进行流式传输。
568+
如果升级到 WebSocket 失败，命令将回退到使用当前的 SPDY 协议。
569+
</td>
570+
</tr>
571+
546572
<tr>
547573
<td colspan="2">KUBECTL_REMOTE_COMMAND_WEBSOCKETS</td>
548574
</tr>

0 commit comments

Comments
 (0)