[zh]Resync Reference files[11]
caodonghui
parent
fe81c57bee
commit
c73d0510b9
|
|
@ -15,6 +15,7 @@ linkTitle: "Reference"
|
|||
main_menu: true
|
||||
weight: 70
|
||||
content_type: concept
|
||||
no_list: true
|
||||
-->
|
||||
|
||||
<!-- overview -->
|
||||
|
|
@ -29,16 +30,26 @@ This section of the Kubernetes documentation contains references.
|
|||
<!--
|
||||
## API Reference
|
||||
|
||||
* [API Reference for Kubernetes {{< param "version" >}}](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)
|
||||
* [Glossary](/docs/reference/glossary/) - a comprehensive, standardized list of Kubernetes terminology
|
||||
|
||||
* [Kubernetes API Reference](/docs/reference/kubernetes-api/)
|
||||
* [One-page API Reference for Kubernetes {{< param "version" >}}](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)
|
||||
* [Using The Kubernetes API](/docs/reference/using-api/) - overview of the API for Kubernetes.
|
||||
* [API access control](/docs/reference/access-authn-authz/) - details on how Kubernetes controls API access
|
||||
* [Well-Known Labels, Annotations and Taints](/docs/reference/labels-annotations-taints/)
|
||||
-->
|
||||
## API 参考
|
||||
|
||||
* [术语表](/zh/docs/reference/glossary/) - 一个全面的标准化的 Kubernetes 术语表
|
||||
|
||||
* [Kubernetes API 单页参考](/zh/docs/reference/kubernetes-api/)
|
||||
* [Kubernetes API 参考 {{< param "version" >}}](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)。
|
||||
* [使用 Kubernetes API ](/zh/docs/reference/using-api/) - Kubernetes 的 API 概述
|
||||
* [API 的访问控制](/zh/docs/reference/access-authn-authz/) - 关于 Kubernetes 如何控制 API 访问的详细信息
|
||||
* [常见的标签、注解和污点](/zh/docs/reference/labels-annotations-taints/)
|
||||
|
||||
<!--
|
||||
## API Client Libraries
|
||||
## Officially supported client libraries
|
||||
|
||||
To call the Kubernetes API from a programming language, you can use
|
||||
[client libraries](/docs/reference/using-api/client-libraries/). Officially supported
|
||||
|
|
@ -48,8 +59,10 @@ client libraries:
|
|||
- [Kubernetes Python client library](https://github.com/kubernetes-client/python)
|
||||
- [Kubernetes Java client library](https://github.com/kubernetes-client/java)
|
||||
- [Kubernetes JavaScript client library](https://github.com/kubernetes-client/javascript)
|
||||
- [Kubernetes Dotnet client library](https://github.com/kubernetes-client/csharp)
|
||||
- [Kubernetes Haskell Client library](https://github.com/kubernetes-client/haskell)
|
||||
-->
|
||||
## API 客户端库
|
||||
## 官方支持的客户端库
|
||||
|
||||
如果您需要通过编程语言调用 Kubernetes API，您可以使用
|
||||
[客户端库](/zh/docs/reference/using-api/client-libraries/)。以下是官方支持的客户端库：
|
||||
|
|
@ -58,16 +71,17 @@ client libraries:
|
|||
- [Kubernetes Python 语言客户端库](https://github.com/kubernetes-client/python)
|
||||
- [Kubernetes Java 语言客户端库](https://github.com/kubernetes-client/java)
|
||||
- [Kubernetes JavaScript 语言客户端库](https://github.com/kubernetes-client/javascript)
|
||||
- [Kubernetes Dotnet 语言客户端库](https://github.com/kubernetes-client/csharp)
|
||||
- [Kubernetes Haskell 语言客户端库](https://github.com/kubernetes-client/haskell)
|
||||
|
||||
<!--
|
||||
## CLI Reference
|
||||
## CLI
|
||||
|
||||
* [kubectl](/docs/user-guide/kubectl-overview) - Main CLI tool for running commands and managing Kubernetes clusters.
|
||||
* [JSONPath](/docs/user-guide/jsonpath/) - Syntax guide for using [JSONPath expressions](http://goessner.net/articles/JsonPath/) with kubectl.
|
||||
* [kubeadm](/docs/admin/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster.
|
||||
* [kubefed](/docs/admin/kubefed/) - CLI tool to help you administrate your federated clusters.
|
||||
* [kubectl](/docs/reference/kubectl/overview/) - Main CLI tool for running commands and managing Kubernetes clusters.
|
||||
* [JSONPath](/docs/reference/kubectl/jsonpath/) - Syntax guide for using [JSONPath expressions](https://goessner.net/articles/JsonPath/) with kubectl.
|
||||
* [kubeadm](/docs/reference/setup-tools/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster.
|
||||
-->
|
||||
## CLI 参考
|
||||
## CLI
|
||||
|
||||
* [kubectl](/zh/docs/reference/kubectl/overview/) - 主要的 CLI 工具，用于运行命令和管理 Kubernetes 集群。
|
||||
* [JSONPath](/zh/docs/reference/kubectl/jsonpath/) - 通过 kubectl 使用
|
||||
|
|
@ -75,29 +89,75 @@ client libraries:
|
|||
* [kubeadm](/zh/docs/reference/setup-tools/kubeadm/) - 此 CLI 工具可轻松配置安全的 Kubernetes 集群。
|
||||
|
||||
<!--
|
||||
## Components Reference
|
||||
## Components
|
||||
|
||||
* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The primary *node agent* that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy.
|
||||
* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API that validates and configures data for API objects such as pods, services, replication controllers.
|
||||
* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The
|
||||
primary agent that runs on each node. The kubelet takes a set of PodSpecs
|
||||
and ensures that the described containers are running and healthy.
|
||||
* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) -
|
||||
REST API that validates and configures data for API objects such as pods,
|
||||
services, replication controllers.
|
||||
* [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - Daemon that embeds the core control loops shipped with Kubernetes.
|
||||
* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across a set of back-ends.
|
||||
* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can
|
||||
do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across
|
||||
a set of back-ends.
|
||||
* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - Scheduler that manages availability, performance, and capacity.
|
||||
* [kube-scheduler Policies](/docs/reference/scheduling/policies)
|
||||
* [kube-scheduler Profiles](/docs/reference/scheduling/config#profiles)
|
||||
|
||||
* [Scheduler Policies](/docs/reference/scheduling/policies)
|
||||
* [Scheduler Profiles](/docs/reference/scheduling/config#profiles)
|
||||
-->
|
||||
## 组件参考
|
||||
## 组件
|
||||
|
||||
* [kubelet](/zh/docs/reference/command-line-tools-reference/kubelet/) -
|
||||
在每个节点上运行的主代理。kubelet 接收一组 PodSpecs 并确保其所描述的容器健康地运行。
|
||||
* [kube-apiserver](/zh/docs/reference/command-line-tools-reference/kube-apiserver/) -
|
||||
REST API，用于验证和配置 API 对象（如 Pod、服务或副本控制器等）的数据。
|
||||
* [kube-controller-manager](/zh/docs/reference/command-line-tools-reference/kube-controller-manager/) -
|
||||
一个守护进程，其中包含 Kubernetes 所附带的核心控制回路。
|
||||
* [kube-proxy](/zh/docs/reference/command-line-tools-reference/kube-proxy/) -
|
||||
可进行简单的 TCP/UDP 流转发或针对一组后端执行轮流 TCP/UDP 转发。
|
||||
* [kube-scheduler](/zh/docs/reference/command-line-tools-reference/kube-scheduler/) -
|
||||
一个调度程序，用于管理可用性、性能和容量。
|
||||
|
||||
* [调度策略](/zh/docs/reference/scheduling/policies)
|
||||
* [调度配置](/zh/docs/reference/scheduling/config#profiles)
|
||||
|
||||
<!--
|
||||
## Config APIs
|
||||
|
||||
This section hosts the documentation for "unpublished" APIs which are used to
|
||||
configure kubernetes components or tools. Most of these APIs are not exposed
|
||||
by the API server in a RESTful way though they are essential for a user or an
|
||||
operator to use or manage a cluster.
|
||||
|
||||
* [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
|
||||
* [kube-scheduler configuration (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/)
|
||||
* [kube-scheduler policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/)
|
||||
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
|
||||
* [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/)
|
||||
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
|
||||
* [WebhookAdmission configuration (v1)](/docs/reference/config-api/apiserver-webhookadmission.v1/)
|
||||
-->
|
||||
## 配置 API
|
||||
|
||||
本节包含用于配置 kubernetes 组件或工具的 "未发布" API 的文档。
|
||||
尽管这些 API 对于用户或操作者使用或管理集群来说是必不可少的，
|
||||
它们大都没有以 RESTful 的方式在 API 服务器上公开。
|
||||
|
||||
* [kubelet 配置 (v1beta1)](/zh/docs/reference/config-api/kubelet-config.v1beta1/)
|
||||
* [kube-scheduler 配置 (v1beta1)](/zh/docs/reference/config-api/kube-scheduler-config.v1beta1/)
|
||||
* [kube-scheduler 策略参考 (v1)](/zh/docs/reference/config-api/kube-scheduler-policy-config.v1/)
|
||||
* [kube-proxy 配置 (v1alpha1)](/zh/docs/reference/config-api/kube-proxy-config.v1alpha1/)
|
||||
* [`audit.k8s.io/v1` API](/zh/docs/reference/config-api/apiserver-audit.v1/)
|
||||
* [客户端认证 API (v1beta1)](/zh/docs/reference/config-api/client-authentication.v1beta1/)
|
||||
* [WebhookAdmission 配置 (v1)](/zh/docs/reference/config-api/apiserver-webhookadmission.v1/)
|
||||
|
||||
* [kubelet](/zh/docs/reference/command-line-tools-reference/kubelet/) - 在每个节点上运行的主 *节点代理* 。kubelet 采用一组 PodSpecs 并确保所描述的容器健康地运行。
|
||||
* [kube-apiserver](/zh/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API，用于验证和配置 API 对象（如 Pod、服务或副本控制器等）的数据。
|
||||
* [kube-controller-manager](/zh/docs/reference/command-line-tools-reference/kube-controller-manager/) - 一个守护进程，它嵌入到了 Kubernetes 的附带的核心控制循环。
|
||||
* [kube-proxy](/zh/docs/reference/command-line-tools-reference/kube-proxy/) - 可进行简单的 TCP/UDP 流转发或针对一组后端执行轮流 TCP/UDP 转发。
|
||||
* [kube-scheduler](/zh/docs/reference/command-line-tools-reference/kube-scheduler/) - 一个调度程序，用于管理可用性、性能和容量。
|
||||
* [kube-scheduler 策略](/zh/docs/reference/scheduling/policies)
|
||||
* [kube-scheduler 配置](/zh/docs/reference/scheduling/config#profiles)
|
||||
<!--
|
||||
## Design Docs
|
||||
|
||||
An archive of the design docs for Kubernetes functionality. Good starting points are [Kubernetes Architecture](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md) and [Kubernetes Design Overview](https://git.k8s.io/community/contributors/design-proposals).
|
||||
An archive of the design docs for Kubernetes functionality. Good starting points are
|
||||
[Kubernetes Architecture](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md) and
|
||||
[Kubernetes Design Overview](https://git.k8s.io/community/contributors/design-proposals).
|
||||
-->
|
||||
## 设计文档
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,26 @@ The Kubelet populates this with `runtime.GOOS` as defined by Go. This can be han
|
|||
-->
|
||||
Kubelet 用 Go 定义的 `runtime.GOOS` 生成该标签的键值。在混合使用异构操作系统场景下（例如：混合使用 Linux 和 Windows 节点），此键值可以带来极大便利。
|
||||
|
||||
## kubernetes.io/metadata.name
|
||||
|
||||
示例：`kubernetes.io/metadata.name=mynamespace`
|
||||
|
||||
用于：Namespaces
|
||||
|
||||
<!--
|
||||
When the `NamespaceDefaultLabelName`
|
||||
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled,
|
||||
the Kubernetes API server sets this label on all namespaces. The label value is set to
|
||||
the name of the namespace.
|
||||
|
||||
This is useful if you want to target a specific namespace with a label
|
||||
{{< glossary_tooltip text="selector" term_id="selector" >}}.
|
||||
-->
|
||||
当 `NamespaceDefaultLabelName` [特性门控](/zh/docs/reference/command-line-tools-reference/feature-gates/)
|
||||
被启用时，Kubernetes API 服务器会在所有命名空间上设置此标签。标签值被设置为命名空间的名称。
|
||||
|
||||
如果你想使用标签 {{< glossary_tooltip text="选择器" term_id="selector" >}} 来指向特定的命名空间，这很有用。
|
||||
|
||||
## beta.kubernetes.io/arch (deprecated)
|
||||
|
||||
<!--
|
||||
|
|
@ -75,6 +95,19 @@ Kubelet 用主机名生成此标签。需要注意的是主机名可修改，这
|
|||
|
||||
此标签也可用做拓扑层次的一个部分。更多信息参见[topology.kubernetes.io/zone](#topologykubernetesiozone)。
|
||||
|
||||
## controller.kubernetes.io/pod-deletion-cost {#pod-deletion-cost}
|
||||
|
||||
示例：`controller.kubernetes.io/pod-deletion-cost=10`
|
||||
|
||||
用于：Pod
|
||||
|
||||
<!--
|
||||
This annotation is used to set [Pod Deletion Cost](/docs/concepts/workloads/controllers/replicaset/#pod-deletion-cost)
|
||||
which allows users to influence ReplicaSet downscaling order. The annotation parses into an `int32` type.
|
||||
-->
|
||||
该注解用于设置 [Pod 删除开销](/zh/docs/concepts/workloads/controllers/replicaset/#pod-deletion-cost)，
|
||||
允许用户影响 ReplicaSet 的缩减顺序。该注解解析为 `int32` 类型。
|
||||
|
||||
## beta.kubernetes.io/instance-type (deprecated)
|
||||
|
||||
{{< note >}}
|
||||
|
|
@ -124,6 +157,22 @@ Starting in v1.17, this label is deprecated in favor of [topology.kubernetes.io/
|
|||
从 v1.17 开始，此标签被弃用，取而代之的是 [topology.kubernetes.io/zone](#topologykubernetesiozone).
|
||||
{{< /note >}}
|
||||
|
||||
## statefulset.kubernetes.io/pod-name {#statefulsetkubernetesiopod-name}
|
||||
|
||||
示例：`statefulset.kubernetes.io/pod-name=mystatefulset-7`
|
||||
|
||||
<!--
|
||||
When a StatefulSet controller creates a Pod for the StatefulSet, the control plane
|
||||
sets this label on that Pod. The value of the label is the name of the Pod being created.
|
||||
|
||||
See [Pod Name Label](/docs/concepts/workloads/controllers/statefulset/#pod-name-label) in the
|
||||
StatefulSet topic for more details.
|
||||
-->
|
||||
当 StatefulSet 控制器为 StatefulSet 创建 Pod 时，控制平面会在该 Pod 上设置此标签。
|
||||
标签的值是正在创建的 Pod 的名称。
|
||||
|
||||
更多细节请参见 StatefulSet 文章中的 [Pod 名称标签](/zh/docs/concepts/workloads/controllers/statefulset/#pod-name-label)。
|
||||
|
||||
## topology.kubernetes.io/region {#topologykubernetesioregion}
|
||||
|
||||
示例
|
||||
|
|
@ -316,6 +365,17 @@ Starting in v1.18, this annotation is deprecated in favor of `spec.ingressClassN
|
|||
从 v1.18 开始，此注解被弃用，取而代之的是 `spec.ingressClassName`。
|
||||
{{< /note >}}
|
||||
|
||||
## storageclass.kubernetes.io/is-default-class
|
||||
|
||||
示例：`storageclass.kubernetes.io/is-default-class=true`
|
||||
|
||||
用于：StorageClass
|
||||
|
||||
<!--
|
||||
When a single StorageClass resource has this annotation set to `"true"`, new Physical Volume Claim resource without a class specified will be assigned this default class.
|
||||
-->
|
||||
当单个的 StorageClass 资源将这个注解设置为 `"true"` 时，新的持久卷申领（PVC）
|
||||
资源若未指定类别，将被设定为此默认类别。
|
||||
|
||||
## alpha.kubernetes.io/provided-node-ip
|
||||
|
||||
|
|
@ -327,14 +387,50 @@ Starting in v1.18, this annotation is deprecated in favor of `spec.ingressClassN
|
|||
The kubelet can set this annotation on a Node to denote its configured IPv4 address.
|
||||
|
||||
When kubelet is started with the "external" cloud provider, it sets this annotation on the Node to denote an IP address set from the command line flag (`--node-ip`). This IP is verified with the cloud provider as valid by the cloud-controller-manager.
|
||||
|
||||
**The taints listed below are always used on Nodes**
|
||||
-->
|
||||
kubectl 在 Node 上设置此注解，表示它的 IPv4 地址。
|
||||
|
||||
当 kubectl 由外部的云供应商启动时，在 Node 上设置此注解，表示由命令行标记(`--node-ip`)设置的 IP 地址。
|
||||
cloud-controller-manager 向云供应商验证此 IP 是否有效。
|
||||
|
||||
## batch.kubernetes.io/job-completion-index
|
||||
|
||||
示例：`batch.kubernetes.io/job-completion-index: "3"`
|
||||
|
||||
用于：Pod
|
||||
|
||||
<!--
|
||||
The Job controller in the kube-controller-manager sets this annotation for Pods
|
||||
created with Indexed [completion mode](/docs/concepts/workloads/controllers/job/#completion-mode).
|
||||
-->
|
||||
kube-controller-manager 中的 Job 控制器给创建使用索引
|
||||
[完成模式](/zh/docs/concepts/workloads/controllers/job/#completion-mode)
|
||||
的 Pod 设置此注解。
|
||||
|
||||
## kubectl.kubernetes.io/default-container
|
||||
|
||||
示例：`kubectl.kubernetes.io/default-container: "front-end-app"`
|
||||
|
||||
<!--
|
||||
The value of the annotation is the container name that is default for this Pod. For example, `kubectl logs` or `kubectl exec` without `-c` or `--container` flag will use this default container.
|
||||
-->
|
||||
注解的值是此 Pod 的默认容器名称。
|
||||
例如，`kubectl logs` 或 `kubectl exec` 没有 `-c` 或 `--container` 参数时，将使用这个默认的容器。
|
||||
|
||||
## endpoints.kubernetes.io/over-capacity
|
||||
|
||||
示例：`endpoints.kubernetes.io/over-capacity:warning`
|
||||
|
||||
用于：Endpoints
|
||||
|
||||
<!--
|
||||
In Kubernetes clusters v1.21 (or later), the Endpoints controller adds this annotation to an Endpoints resource if it has more than 1000 endpoints. The annotation indicates that the Endpoints resource is over capacity.
|
||||
|
||||
**The taints listed below are always used on Nodes**
|
||||
-->
|
||||
在 Kubernetes 集群 v1.21（或更高版本）中，如果 Endpoint 超过 1000 个，Endpoint 控制器
|
||||
就会向其添加这个注解。该注解表示 Endpoint 资源已超过容量。
|
||||
|
||||
**以下列出的污点只能用于 Node**
|
||||
|
||||
## node.kubernetes.io/not-ready
|
||||
|
|
|
|||
Loading…
Reference in New Issue