Skip to content

Commit 33aff50

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #25796 from yuandongx/patch-2
[zh]Synchronize with "/zh/docs/reference/kubectl/conventions/" in English
2 parents 5817800 + cd8ba39 commit 33aff50

File tree

1 file changed

+47
-74
lines changed

1 file changed

+47
-74
lines changed

‎content/zh/docs/reference/kubectl/conventions.md

Lines changed: 47 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ content_type: concept
1818
<!--
1919
Recommended usage conventions for `kubectl`.
2020
-->
21-
`kubectl` 的推荐用法约定
21+
`kubectl` 的推荐用法约定。
2222

2323

2424
<!-- body -->
@@ -36,13 +36,11 @@ For a stable output in a script:
3636
<!--
3737
* Request one of the machine-oriented output forms, such as `-o name`, `-o json`, `-o yaml`, `-o go-template`, or `-o jsonpath`.
3838
* Fully-qualify the version. For example, `jobs.v1.batch/myjob`. This will ensure that kubectl does not use its default version that can change over time.
39-
* Specify the `--generator` flag to pin to a specific behavior when you use generator-based commands such as `kubectl run` or `kubectl expose`.
4039
* Don't rely on context, preferences, or other implicit states.
4140
-->
4241

4342
* 请求一个面向机器的输出格式，例如 `-o name`、`-o json`、`-o yaml`、`-o go template` 或 `-o jsonpath`。
4443
* 完全限定版本。例如 `jobs.v1.batch/myjob`。这将确保 kubectl 不会使用其默认版本，该版本会随着时间的推移而更改。
45-
* 在使用基于生成器的命令（例如 `kubectl run` 或者 `kubectl expose`）时，指定 `--generator` 参数以固定到特定行为。
4644
* 不要依赖上下文、首选项或其他隐式状态。
4745

4846
<!--
@@ -59,99 +57,74 @@ For `kubectl run` to satisfy infrastructure as code:
5957

6058
<!--
6159
* Tag the image with a version-specific tag and don't move that tag to a new version. For example, use `:v1234`, `v1.2.3`, `r03062016-1-4`, rather than `:latest` (For more information, see [Best Practices for Configuration](/docs/concepts/configuration/overview/#container-images)).
62-
* Capture the parameters in a checked-in script, or at least use `--record` to annotate the created objects with the command line for an image that is lightly parameterized.
63-
* Pin to a specific [generator](#generators) version, such as `kubectl run --generator=run-pod/v1`.
6460
* Check in the script for an image that is heavily parameterized.
6561
* Switch to configuration files checked into source control for features that are needed, but not expressible via `kubectl run` flags.
6662
-->
6763

6864
* 使用特定版本的标签标记镜像，不要将该标签移动到新版本。例如，使用 `:v1234`、`v1.2.3`、`r03062016-1-4`，而不是 `:latest`（有关详细信息，请参阅[配置的最佳实践](/zh/docs/concepts/configuration/overview/#container-images))。
69-
* 固定到特定的[生成器](#生成器)版本，例如 `kubectl run --generator=run-pod/v1`。
70-
* 使用基于版本控制的脚本来记录所使用的参数，或者至少使用 `--record` 参数以便为所创建的对象添加注解，在使用轻度参数化的镜像时，记录下所使用的命令行。
7165
* 使用基于版本控制的脚本来运行包含大量参数的镜像。
7266
* 对于无法通过 `kubectl run` 参数来表示的功能特性，使用基于源码控制的配置文件，以记录要使用的功能特性。
7367

7468
<!--
75-
#### Generators
76-
-->
77-
#### 生成器
78-
79-
<!--
80-
You can create the following resources using `kubectl run` with the `--generator` flag:
69+
You can use the `--dry-run=client` flag to preview the object that would be sent to your cluster, without really submitting it.
8170
-->
82-
您可以使用带有 `--generator` 参数的 `kubectl run` 命令创建如下资源：
83-
84-
<!--
85-
{{< table caption="Resources you can create using kubectl run" >}}
86-
| Resource | API group | kubectl command |
87-
|--------------------------------------|--------------------|---------------------------------------------------|
88-
| Pod | v1 | `kubectl run --generator=run-pod/v1` |
89-
| ReplicationController _(deprecated)_ | v1 | `kubectl run --generator=run/v1` |
90-
| Deployment _(deprecated)_ | extensions/v1beta1 | `kubectl run --generator=deployment/v1beta1` |
91-
| Deployment _(deprecated)_ | apps/v1beta1 | `kubectl run --generator=deployment/apps.v1beta1` |
92-
| Job _(deprecated)_ | batch/v1 | `kubectl run --generator=job/v1` |
93-
| CronJob _(deprecated)_ | batch/v2alpha1 | `kubectl run --generator=cronjob/v2alpha1` |
94-
| CronJob _(deprecated)_ | batch/v1beta1 | `kubectl run --generator=cronjob/v1beta1` |
95-
{{< /table >}}
96-
-->
97-
{{< table caption="可以使用 kubectl run 创建的资源" >}}
98-
| 资源 | API 组 | kubectl 命令 |
99-
|----------------------------------|--------------------|-------------------------------------------------- |
100-
| Pod | v1 | `kubectl run --generator=run-pod/v1` |
101-
| ReplicationController _(已弃用)_ | v1 | `kubectl run --generator=run/v1` |
102-
| Deployment _(已弃用)_ | extensions/v1beta1 | `kubectl run --generator=deployment/v1beta1` |
103-
| Deployment _(已弃用)_ | apps/v1beta1 | `kubectl run --generator=deployment/apps.v1beta1` |
104-
| Job _(已弃用)_ | batch/v1 | `kubectl run --generator=job/v1` |
105-
| CronJob _(已弃用)_ | batch/v2alpha1 | `kubectl run --generator=cronjob/v2alpha1` |
106-
| CronJob _(已弃用)_ | batch/v1beta1 | `kubectl run --generator=cronjob/v1beta1` |
107-
{{< /table >}}
71+
你可以使用 `--dry-run=client` 参数来预览而不真正提交即将下发到集群的对象实例：
10872

10973
{{< note >}}
110-
<!--Generators other than `run-pod/v1` are deprecated.-->
111-
不推荐使用 `run-pod/v1` 以外的其他生成器.
112-
{{< /note >}}
113-
11474
<!--
115-
If you explicitly set `--generator`, kubectl uses the generator you specified. If you invoke `kubectl run` and don't specify a generator, kubectl automatically selects which generator to use based on the other flags you set. The following table lists flags and the generators that are activated if you didn't specify one yourself:
75+
All `kubectl run` generators are deprecated.
76+
See the Kubernetes v1.17 documentation for a [list](https://v1-17.docs.kubernetes.io/docs/reference/kubectl/conventions/#generators) of generators and how they were used.
11677
-->
117-
如果您显式设置了 `--generator` 参数，kubectl 将使用您指定的生成器。如果使用 `kubectl run` 命令但是未指定生成器，kubectl 会根据您设置的其他参数自动选择要使用的生成器。下表列出了如果您自己未指定参数自动使用与之相匹配的生成器：
118-
119-
<!--
120-
{{< table caption="kubectl run flags and the resource they imply" >}}
121-
| Flag | Generated Resource |
122-
|-------------------------|-----------------------|
123-
| `--schedule=<schedule>` | CronJob |
124-
| `--restart=Always` | Deployment |
125-
| `--restart=OnFailure` | Job |
126-
| `--restart=Never` | Pod |
127-
{{< /table >}}
128-
-->
129-
{{< table caption="kubectl run 参数及其对应的资源" >}}
130-
| 参数 | 相匹配的资源 |
131-
|-------------------------|-----------------------|
132-
| `--schedule=<schedule>` | CronJob |
133-
| `--restart=Always` | Deployment |
134-
| `--restart=OnFailure` | Job |
135-
| `--restart=Never` | Pod |
136-
{{< /table >}}
78+
所有的 `kubectl run` 生成器已弃用。
79+
查阅 Kubernetes v1.17 文档中的生成器[列表](https://v1-17.docs.kubernetes.io/docs/reference/kubectl/conventions/#generators)以及它们的用法。
80+
{{< /note >}}
13781

13882
<!--
139-
If you don't specify a generator, kubectl pays attention to other flags in the following order:
83+
#### Generators
14084
-->
141-
如果不指定生成器，kubectl 将按以下顺序考虑其他参数：
142-
143-
1. `--schedule`
144-
1. `--restart`
145-
85+
#### 生成器
14686
<!--
147-
You can use the `--dry-run` flag to preview the object that would be sent to your cluster, without really submitting it.
148-
-->
149-
您可以使用 `--dry-run` 参数预览要发送到集群的对象，而无需真正提交。
87+
You can generate the following resources with a kubectl command, `kubectl create --dry-run=client -o yaml`:
88+
```
89+
clusterrole Create a ClusterRole.
90+
clusterrolebinding Create a ClusterRoleBinding for a particular ClusterRole.
91+
configmap Create a configmap from a local file, directory or literal value.
92+
cronjob Create a cronjob with the specified name.
93+
deployment Create a deployment with the specified name.
94+
job Create a job with the specified name.
95+
namespace Create a namespace with the specified name.
96+
poddisruptionbudget Create a pod disruption budget with the specified name.
97+
priorityclass Create a priorityclass with the specified name.
98+
quota Create a quota with the specified name.
99+
role Create a role with single rule.
100+
rolebinding Create a RoleBinding for a particular Role or ClusterRole.
101+
secret Create a secret using specified subcommand.
102+
service Create a service using specified subcommand.
103+
serviceaccount Create a service account with the specified name.
104+
```
105+
-->
106+
你可以使用 kubectl 命令生成以下资源， `kubectl create --dry-run=client -o yaml`：
107+
```
108+
clusterrole 创建 ClusterRole。
109+
clusterrolebinding 为特定的 ClusterRole 创建 ClusterRoleBinding。
110+
configmap 使用本地文件、目录或文本值创建 Configmap。
111+
cronjob 使用指定的名称创建 Cronjob。
112+
deployment 使用指定的名称创建 Deployment。
113+
job 使用指定的名称创建 Job。
114+
namespace 使用指定的名称创建名称空间。
115+
poddisruptionbudget 使用指定名称创建 Pod 干扰预算。
116+
priorityclass 使用指定的名称创建 Priorityclass。
117+
quota 使用指定的名称创建配额。
118+
role 使用单一规则创建角色。
119+
rolebinding 为特定角色或 ClusterRole 创建 RoleBinding。
120+
secret 使用指定的子命令创建 Secret。
121+
service 使用指定的子命令创建服务。
122+
serviceaccount 使用指定的名称创建服务帐户。
123+
```
150124

151125
### `kubectl apply`
152126

153127
<!--
154128
* You can use `kubectl apply` to create or update resources. For more information about using kubectl apply to update resources, see [Kubectl Book](https://kubectl.docs.kubernetes.io).
155129
-->
156-
157130
* 您可以使用 `kubectl apply` 命令创建或更新资源。有关使用 kubectl apply 更新资源的详细信息，请参阅 [Kubectl 文档](https://kubectl.docs.kubernetes.io)。

0 commit comments

Comments
 (0)