From d0dca853ff463753376bd36d35feee602c628f52 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Mon, 15 May 2023 09:44:38 +0800 Subject: [PATCH] [zh] sync apiserver-config.v1alpha1.md --- .../config-api/apiserver-config.v1alpha1.md | 266 +++++++++++++----- 1 file changed, 194 insertions(+), 72 deletions(-) diff --git a/content/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1.md b/content/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1.md index b399f304e32..83ceea90d0a 100644 --- a/content/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1.md +++ b/content/zh-cn/docs/reference/config-api/apiserver-config.v1alpha1.md @@ -2,7 +2,6 @@ title: kube-apiserver 配置 (v1alpha1) content_type: tool-reference package: apiserver.k8s.io/v1alpha1 -auto_generated: true --- - + +

包 v1alpha1 包含 API 的 v1alpha1 版本。

-## 资源类型 +## 资源类型 {#resource-types} - [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) - [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration) @@ -24,7 +26,10 @@ auto_generated: true ## `AdmissionConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionConfiguration} -

+

+ AdmissionConfiguration 为准入控制器提供版本化的配置信息。

@@ -39,7 +44,10 @@ AdmissionConfiguration 为准入控制器提供版本化的配置信息。 []AdmissionPluginConfiguration -

+

+ plugins 允许用户为每个准入控制插件指定设置。

@@ -49,7 +57,10 @@ AdmissionConfiguration 为准入控制器提供版本化的配置信息。 ## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration} -

+

+ EgressSelectorConfiguration 为 Egress 选择算符客户端提供版本化的配置选项。

@@ -64,7 +75,10 @@ EgressSelectorConfiguration 为 Egress 选择算符客户端提供版本化的 []EgressSelection -

+

+ connectionServices 包含一组 Egress 选择算符客户端配置选项。

@@ -74,7 +88,10 @@ EgressSelectorConfiguration 为 Egress 选择算符客户端提供版本化的 ## `TracingConfiguration` {#apiserver-k8s-io-v1alpha1-TracingConfiguration} -

+

+ TracingConfiguration 为跟踪客户端提供版本化的配置信息。

@@ -85,33 +102,19 @@ TracingConfiguration 为跟踪客户端提供版本化的配置信息。 apiVersion
stringapiserver.k8s.io/v1alpha1 kind
stringTracingConfiguration -endpoint
-string +TracingConfiguration [必需]
+TracingConfiguration -

-在控制面节点上运行的采集器的端点。 -API 服务器在向采集器发送数据时将 egressType 设置为 ControlPlane。 -这里的语法定义在 https://github.com/grpc/grpc/blob/master/doc/naming.md。 -默认值为 otlpgrpc 的默认值，即 localhost:4317 -这一连接是不安全的，且不支持 TLS。 -

- - -samplingRatePerMillion
-int32 - - -

- samplingRatePerMillion 设置每一百万个数据点中要采样的样本个数。默认值为 0。 +（TracingConfiguration 的成员嵌入到这种类型中。） +

+ + 嵌入组件配置中的跟踪配置结构体。

@@ -127,7 +130,10 @@ Defaults to 0.--> - [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) -

+

+ AdmissionPluginConfiguration 为某个插件提供配置信息。

@@ -139,8 +145,11 @@ AdmissionPluginConfiguration 为某个插件提供配置信息。 string -

+

+ name 是准入控制器的名称。此名称必须与所注册的准入插件名称匹配。

@@ -149,7 +158,10 @@ It must match the registered admission plugin name.--> string -

+

+ path 为指向包含插件配置数据的配置文件的路径。

@@ -158,8 +170,11 @@ It must match the registered admission plugin name.--> k8s.io/apimachinery/pkg/runtime.Unknown -

+

+ configuration 是一个嵌入的配置对象，用作插件的配置数据来源。 如果设置了此字段，则使用此字段而不是指向配置文件的路径。

@@ -177,7 +192,10 @@ configuration. If present, it will be used instead of the path to the configurat - [EgressSelection](#apiserver-k8s-io-v1alpha1-EgressSelection) -

+

+ Connection 提供某个 Egress 选择客户端的配置信息。

@@ -189,7 +207,10 @@ Connection 提供某个 Egress 选择客户端的配置信息。 ProtocolType -

+

+ proxyProtocol 是客户端连接到 konnectivity 服务器所使用的协议。

@@ -198,8 +219,11 @@ Connection 提供某个 Egress 选择客户端的配置信息。 Transport -

+

+ transport 定义的是传输层的配置。我们使用这个配置来联系 konnectivity 服务器。 当 proxyProtocol 是 HTTPConnect 或 GRPC 时需要设置此字段。

@@ -229,9 +253,12 @@ EgressSelection 为某个 Egress 选择客户端提供配置信息。 string -

+

+ name 是 Egress 选择器的名称。当前支持的取值有 "controlplane"， "master"，"etcd" 和 "cluster"。 "master" Egress 选择器已被弃用，推荐使用 "controlplane"。 @@ -242,7 +269,10 @@ The "master" egress selector is deprecated in favor of "controlpl Connection -

+

+ connection 是用来配置 Egress 选择器的配置信息。

@@ -263,7 +293,10 @@ The "master" egress selector is deprecated in favor of "controlpl - [Connection](#apiserver-k8s-io-v1alpha1-Connection) -

+

+ ProtocolType 是 connection.protocolType 的合法值集合。

@@ -276,7 +309,10 @@ ProtocolType 是 connection.protocolType 的合法值集合。 - [Transport](#apiserver-k8s-io-v1alpha1-Transport) -

+

+ TCPTransport 提供使用 TCP 连接 konnectivity 服务器时需要的信息。

@@ -288,8 +324,11 @@ TCPTransport 提供使用 TCP 连接 konnectivity 服务器时需要的信息。 string -

+

+ url 是要连接的 konnectivity 服务器的位置。例如 "https://127.0.0.1:8131"。

@@ -298,7 +337,10 @@ As an example it might be "https://127.0.0.1:8131"--> TLSConfig -

+

+ tlsConfig 是使用 TLS 来连接 konnectivity 服务器时需要的信息。

@@ -315,9 +357,11 @@ As an example it might be "https://127.0.0.1:8131"--> - [TCPTransport](#apiserver-k8s-io-v1alpha1-TCPTransport) - -

+

+ TLSConfig 为连接 konnectivity 服务器提供身份认证信息。仅用于 TCPTransport。

@@ -329,9 +373,12 @@ TLSConfig 为连接 konnectivity 服务器提供身份认证信息。仅用于 T string -

+

+ caBundle 是指向用来确定与 konnectivity 服务器间信任欢喜的 CA 证书包的文件位置。 当 tcpTransport.url 前缀为 "http://" 时必须不设置，或者设置为空。 如果 tcpTransport.url 前缀为 "https://" 并且此字段未设置，则默认使用系统的信任根。 @@ -342,9 +389,11 @@ If absent while TCPTransport.URL is prefixed with https://, default to system tr string -

+

clientKey 是与 konnectivity 服务器进行 mtls 握手时使用的客户端秘钥文件位置。 如果 `tcp.url` 前缀为 http://，必须不指定或者为空； 如果 `tcp.url` 前缀为 https://，必须设置。 @@ -355,9 +404,12 @@ Must be configured if TCPTransport.URL is prefixed with https://--> string -

+

+ clientCert 是与 konnectivity 服务器进行 mtls 握手时使用的客户端证书文件位置。 如果 `tcp.url` 前缀为 http://，必须不指定或者为空； 如果 `tcp.url` 前缀为 https://，必须设置。 @@ -377,7 +429,10 @@ Must be configured if TCPTransport.URL is prefixed with https://--> - [Connection](#apiserver-k8s-io-v1alpha1-Connection) -

+

+ Transport 定义联系 konnectivity 服务器时要使用的传输层配置。

@@ -389,9 +444,12 @@ Transport 定义联系 konnectivity 服务器时要使用的传输层配置。 TCPTransport -

+

+ tcp 包含通过 TCP 与 konnectivity 服务器通信时使用的 TCP 配置。 目前使用 TCP 传输时不支持 GRPC 的 proxyProtocol。 tcp 和 uds 二者至少设置一个。 @@ -402,8 +460,11 @@ Requires at least one of TCP or UDS to be set--> UDSTransport -

+

+ uds 包含通过 UDS 与 konnectivity 服务器通信时使用的 UDS 配置。 tcp 和 uds 二者至少设置一个。

@@ -421,7 +482,10 @@ Requires at least one of TCP or UDS to be set--> - [Transport](#apiserver-k8s-io-v1alpha1-Transport) -

+

+ UDSTransport 设置通过 UDS 连接 konnectivity 服务器时需要的信息。

@@ -434,8 +498,11 @@ UDSTransport 设置通过 UDS 连接 konnectivity 服务器时需要的信息。 string -

+

+ udsName 是与 konnectivity 服务器连接时使用的 UNIX 域套接字名称。 字段取值不要求包含 unix:// 前缀。 （例如：/etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket） @@ -445,3 +512,58 @@ This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-server +## `TracingConfiguration` {#TracingConfiguration} + + +**出现在：** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + +- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration) + +

+ +TracingConfiguration 为 OpenTelemetry 跟踪客户端提供了不同版本的配置。 +

+ + + + + + + + + + + + +
字段描述
endpoint
+string +		 +

+ + 采集器的端点，此组件将向其报告跟踪信息。 + 连接不安全，目前不支持 TLS。 + 推荐不设置，端点为 otlp grpc 默认值 localhost:4317。 +

+
samplingRatePerMillion
+int32 +		 +

+ + SamplingRatePerMillion 是每百万 span 中采集的样本数。 + 推荐不设置。如果不设置，采集器将继承其父级 span 的采样率，否则不进行采样。 +

+