Skip to content

Commit

Permalink
[zh-cn] sync kubectl/_index kubectl quick-reference reference/_index
Browse files Browse the repository at this point in the history
Signed-off-by: xin.li <xin.li@daocloud.io>
  • Loading branch information
my-git9 committed May 13, 2024
1 parent 5326ca6 commit bd86f84
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 53 deletions.
52 changes: 23 additions & 29 deletions content/zh-cn/docs/reference/_index.md
Expand Up @@ -140,15 +140,12 @@ operator to use or manage a cluster.
* [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and
[kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and
[kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
* [kube-apiserver encryption (v1)](/docs/reference/config-api/apiserver-encryption.v1/)
* [kube-apiserver event rate limit (v1alpha1)](/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
[kubelet configuration (v1)](/docs/reference/config-api/kubelet-config.v1/)
* [kubelet credential providers (v1alpha1)](/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/),
[kubelet credential providers (v1beta1)](/docs/reference/config-api/kubelet-credentialprovider.v1beta1/) and
[kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
* [kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
[kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/)
* [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
Expand All @@ -164,28 +161,25 @@ operator to use or manage a cluster.
尽管这些 API 对于用户或操作者使用或管理集群来说是必不可少的,
它们大都没有以 RESTful 的方式在 API 服务器上公开。

* [kubeconfig (v1)](/zh-cn/docs/reference/config-api/kubeconfig.v1/)
* [kube-apiserver 准入 (v1)](/zh-cn/docs/reference/config-api/apiserver-admission.v1/)
* [kube-apiserver 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1/)
[kube-apiserver 配置 (v1beta1)](/zh-cn/docs/reference/config-api/apiserver-config.v1beta1/)
[kube-apiserver 配置 (v1)](/zh-cn/docs/reference/config-api/apiserver-config.v1/)
* [kube-apiserver 加密 (v1)](/zh-cn/docs/reference/config-api/apiserver-encryption.v1/)
* [kube-apiserver 事件速率限制 (v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
* [kubelet 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/kubelet-config.v1alpha1/)
[kubelet 配置 (v1beta1)](/zh-cn/docs/reference/config-api/kubelet-config.v1beta1/)
[kubelet 配置 (v1)](/zh-cn/docs/reference/config-api/kubelet-config.v1/)
* [kubelet 凭据驱动 (v1alpha1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/)
[kubelet 凭据驱动 (v1beta1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1beta1/)
[kubelet 凭据驱动 (v1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1/)
[kube-scheduler 配置 (v1beta3)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1beta3/)
[kube-scheduler 配置 (v1)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1/)
* [kube-controller-manager 配置 (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
* [kube-proxy 配置 (v1alpha1)](/zh-cn/docs/reference/config-api/kube-proxy-config.v1alpha1/)
* [kubeconfig(v1)](/zh-cn/docs/reference/config-api/kubeconfig.v1/)
* [kube-apiserver 准入(v1)](/zh-cn/docs/reference/config-api/apiserver-admission.v1/)
* [kube-apiserver 配置(v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1/)
[kube-apiserver 配置(v1beta1)](/zh-cn/docs/reference/config-api/apiserver-config.v1beta1/)
[kube-apiserver 配置(v1)](/zh-cn/docs/reference/config-api/apiserver-config.v1/)
* [kube-apiserver 事件速率限制(v1alpha1)](/zh-cn/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
* [kubelet 配置(v1alpha1)](/zh-cn/docs/reference/config-api/kubelet-config.v1alpha1/)
[kubelet 配置(v1beta1)](/zh-cn/docs/reference/config-api/kubelet-config.v1beta1/)
[kubelet 配置(v1)](/zh-cn/docs/reference/config-api/kubelet-config.v1/)
* [kubelet 凭据驱动(v1)](/zh-cn/docs/reference/config-api/kubelet-credentialprovider.v1/)
* [kube-scheduler 配置(v1)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1/)
[kube-scheduler 配置(v1beta3)](/zh-cn/docs/reference/config-api/kube-scheduler-config.v1beta3/)
* [kube-controller-manager 配置(v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
* [kube-proxy 配置(v1alpha1)](/zh-cn/docs/reference/config-api/kube-proxy-config.v1alpha1/)
* [`audit.k8s.io/v1` API](/zh-cn/docs/reference/config-api/apiserver-audit.v1/)
* [客户端身份认证 API (v1beta1)](/zh-cn/docs/reference/config-api/client-authentication.v1beta1/)
[客户端身份认证 API (v1)](/zh-cn/docs/reference/config-api/client-authentication.v1/)
* [WebhookAdmission 配置 (v1)](/zh-cn/docs/reference/config-api/apiserver-webhookadmission.v1/)
* [ImagePolicy API (v1alpha1)](/zh-cn/docs/reference/config-api/imagepolicy.v1alpha1/)
* [客户端身份认证 APIv1beta1](/zh-cn/docs/reference/config-api/client-authentication.v1beta1/)
[客户端身份认证 API(v1)](/zh-cn/docs/reference/config-api/client-authentication.v1/)
* [WebhookAdmission 配置(v1)](/zh-cn/docs/reference/config-api/apiserver-webhookadmission.v1/)
* [ImagePolicy APIv1alpha1](/zh-cn/docs/reference/config-api/imagepolicy.v1alpha1/)

<!--
## Config API for kubeadm
Expand All @@ -212,9 +206,9 @@ by the core project:

这些是 Kubernetes 项目所定义的 API,但不是由核心项目实现的:

* [指标 API (v1beta1)](/zh-cn/docs/reference/external-api/metrics.v1beta1/)
* [自定义指标 API (v1beta2)](/zh-cn/docs/reference/external-api/custom-metrics.v1beta2)
* [外部指标 API (v1beta1)](/zh-cn/docs/reference/external-api/external-metrics.v1beta1)
* [指标 APIv1beta1](/zh-cn/docs/reference/external-api/metrics.v1beta1/)
* [自定义指标 APIv1beta2](/zh-cn/docs/reference/external-api/custom-metrics.v1beta2)
* [外部指标 APIv1beta1](/zh-cn/docs/reference/external-api/external-metrics.v1beta1)

<!--
## Design Docs
Expand Down
22 changes: 11 additions & 11 deletions content/zh-cn/docs/reference/kubectl/_index.md
Expand Up @@ -43,21 +43,21 @@ files by setting the `KUBECONFIG` environment variable or by setting the
<!--
This overview covers `kubectl` syntax, describes the command operations, and provides common examples.
For details about each command, including all the supported flags and subcommands, see the
[kubectl](/docs/reference/generated/kubectl/kubectl-commands/) reference documentation.
[kubectl](/docs/reference/kubectl/generated/kubectl/) reference documentation.
-->
本文概述了 `kubectl` 语法和命令操作描述,并提供了常见的示例。
有关每个命令的详细信息,包括所有受支持的参数和子命令,
请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。
请参阅 [kubectl](/zh-cn/docs/reference/kubectl/generated/kubectl/) 参考文档。

<!--
For installation instructions, see [Installing kubectl](/docs/tasks/tools/#kubectl);
for a quick guide, see the [cheat sheet](/docs/reference/kubectl/cheatsheet/).
for a quick guide, see the [cheat sheet](/docs/reference/kubectl/quick-reference/).
If you're used to using the `docker` command-line tool,
[`kubectl` for Docker Users](/docs/reference/kubectl/docker-cli-to-kubectl/)
explains some equivalent commands for Kubernetes.
-->
有关安装说明,请参见[安装 kubectl](/zh-cn/docs/tasks/tools/#kubectl)
如需快速指南,请参见[备忘单](/zh-cn/docs/reference/kubectl/cheatsheet/)
如需快速指南,请参见[备忘单](/zh-cn/docs/reference/kubectl/quick-reference/)
如果你更习惯使用 `docker` 命令行工具,
[Docker 用户的 `kubectl`](/zh-cn/docs/reference/kubectl/docker-cli-to-kubectl/)
介绍了一些 Kubernetes 的等价命令。
Expand Down Expand Up @@ -300,14 +300,14 @@ Operation | Syntax | Description
`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.
`set` | `kubectl set SUBCOMMAND [options]` | Configure application resources.
`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.
`top` | `kubectl top (POD | NODE) [flags] [options]` | Display Resource (CPU/Memory/Storage) usage.
`top` | <code>kubectl top (POD &#124; NODE) [flags] [options]</code> | Display Resource (CPU/Memory/Storage) usage of pod or node.
`uncordon` | `kubectl uncordon NODE [options]` | Mark node as schedulable.
`version` | `kubectl version [--client] [flags]` | Display the Kubernetes version running on the client and server.
`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.
-->
操作 | 语法 | 描述
-------------------- | -------------------- | --------------------
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | 列出与 alpha 特性对应的可用命令,这些特性在 Kubernetes 集群中默认情况下是不启用的。
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | 列出与 Alpha 级别特性对应的可用命令,这些特性在 Kubernetes 集群中默认情况下是不启用的。
`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> | 添加或更新一个或多个资源的注解。
`api-resources` | `kubectl api-resources [flags]` | 列出可用的 API 资源。
`api-versions` | `kubectl api-versions [flags]` | 列出可用的 API 版本。
Expand All @@ -325,7 +325,7 @@ Operation | Syntax | Description
`create` | `kubectl create -f FILENAME [flags]` | 从文件或 stdin 创建一个或多个资源。
`delete` | <code>kubectl delete (-f FILENAME &#124; TYPE [NAME &#124; /NAME &#124; -l label &#124; --all]) [flags]</code> | 基于文件、标准输入或通过指定标签选择器、名称、资源选择器或资源本身,删除资源。
`describe` | <code>kubectl describe (-f FILENAME &#124; TYPE [NAME_PREFIX &#124; /NAME &#124; -l label]) [flags]</code> | 显示一个或多个资源的详细状态。
`diff` | `kubectl diff -f FILENAME [flags]`| 在当前起作用的配置和文件或标准输之间作对比 (**BETA**)
`diff` | `kubectl diff -f FILENAME [flags]`| 在当前起作用的配置和文件或标准输之间作对比**BETA**
`drain` | `kubectl drain NODE [options]` | 腾空节点以准备维护。
`edit` | <code>kubectl edit (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) [flags]</code> | 使用默认编辑器编辑和更新服务器上一个或多个资源的定义。
`events` | `kubectl events` | 列举事件。
Expand All @@ -347,7 +347,7 @@ Operation | Syntax | Description
`scale` | <code>kubectl scale (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]</code> | 更新指定副本控制器的大小。
`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 (POD | NODE) [flags] [options]` | 显示资源(CPU、内存、存储)的使用情况
`top` | <code>kubectl top (POD &#124; NODE) [flags] [options]</code> | 显示 Pod 或节点的资源(CPU/内存/存储)使用情况
`uncordon` | `kubectl uncordon NODE [options]` | 将节点标记为可调度。
`version` | `kubectl version [--client] [flags]` | 显示运行在客户端和服务器上的 Kubernetes 版本。
`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> | 实验特性:等待一种或多种资源的特定状况。
Expand Down Expand Up @@ -839,7 +839,6 @@ kubectl exec <pod-name> -c <container-name> -- date
# Get an interactive TTY and run /bin/bash from pod <pod-name>. By default, output is from the first container.
kubectl exec -ti <pod-name> -- /bin/bash
-->

```shell
# 从 Pod <pod-name> 中获取运行 'date' 的输出。默认情况下,输出来自第一个容器。
kubectl exec <pod-name> -- date
Expand Down Expand Up @@ -963,6 +962,7 @@ kubectl hello
```
hello world
```

<!--
```shell
# You can "uninstall" a plugin, by removing it from the folder in your
Expand Down Expand Up @@ -1089,15 +1089,15 @@ Current user: plugins-user
<!--
* Read the `kubectl` reference documentation:
* the kubectl [command reference](/docs/reference/kubectl/kubectl/)
* the [command line arguments](/docs/reference/generated/kubectl/kubectl-commands/) reference
* the [command line arguments](/docs/reference/kubectl/generated/kubectl/) reference
* Learn about [`kubectl` usage conventions](/docs/reference/kubectl/conventions/)
* Read about [JSONPath support](/docs/reference/kubectl/jsonpath/) in kubectl
* Read about how to [extend kubectl with plugins](/docs/tasks/extend-kubectl/kubectl-plugins)
* To find out more about plugins, take a look at the [example CLI plugin](https://github.com/kubernetes/sample-cli-plugin).
-->
* 阅读 `kubectl` 参考文档:
* kubectl [命令参考](/zh-cn/docs/reference/kubectl/kubectl/)
* 参考[命令行参数](/docs/reference/generated/kubectl/kubectl-commands/)
* 参考[命令行参数](/docs/reference/kubectl/generated/kubectl/)
* 学习关于 [`kubectl` 使用约定](/zh-cn/docs/reference/kubectl/conventions/)
* 阅读 kubectl 中的 [JSONPath 支持](/zh-cn/docs/reference/kubectl/jsonpath/)
* 了解如何[使用插件扩展 kubectl](/zh-cn/docs/tasks/extend-kubectl/kubectl-plugins)
Expand Down
26 changes: 26 additions & 0 deletions content/zh-cn/docs/reference/kubectl/kubectl.md
Expand Up @@ -518,6 +518,18 @@ When set to false, turns off extra HTTP headers detailing invoked kubectl comman
</td>
</tr>

<tr>
<td colspan="2">KUBECTL_DEBUG_CUSTOM_PROFILE</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">
<!--
When set to true, custom flag will be enabled in kubectl debug. This flag is used to customize the pre-defined profiles.
-->
设置为 true 时,将在 kubectl 调试中启用自定义标志,该标志用于自定义预定义的配置文件。
</td>
</tr>

<tr>
<td colspan="2">KUBECTL_EXPLAIN_OPENAPIV3</td>
</tr>
Expand All @@ -543,6 +555,20 @@ When set to true, external plugins can be used as subcommands for builtin comman
</td>
</tr>

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

<tr>
<td colspan="2">KUBECTL_REMOTE_COMMAND_WEBSOCKETS</td>
</tr>
Expand Down

0 comments on commit bd86f84

Please sign in to comment.