From 92112088e6fb94ad6c49ca63280ec52c2fb926da Mon Sep 17 00:00:00 2001 From: huangminjie Date: Tue, 16 May 2023 16:05:24 +0800 Subject: [PATCH] [zh] sync docs/reference/config-api/apiserver-config.v1beta1.md --- .../config-api/apiserver-config.v1beta1.md | 472 ++++++++++++++++++ 1 file changed, 472 insertions(+) create mode 100644 content/zh-cn/docs/reference/config-api/apiserver-config.v1beta1.md diff --git a/content/zh-cn/docs/reference/config-api/apiserver-config.v1beta1.md b/content/zh-cn/docs/reference/config-api/apiserver-config.v1beta1.md new file mode 100644 index 00000000000..1d35c64e2e0 --- /dev/null +++ b/content/zh-cn/docs/reference/config-api/apiserver-config.v1beta1.md @@ -0,0 +1,472 @@ +--- +title: kube-apiserver 配置 (v1beta1) +content_type: tool-reference +package: apiserver.k8s.io/v1beta1 +--- + + + +

v1beta1 包是 v1beta1 版本的 API。

+ + +## 资源类型 {#resource-types} + +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) +- [TracingConfiguration](#apiserver-k8s-io-v1beta1-TracingConfiguration) + +## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration} + +

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

+ + + + + + + + + + + + +
字段描述
apiVersion
string		apiserver.k8s.io/v1beta1
kind
string		EgressSelectorConfiguration
egressSelections [必需]
+[]EgressSelection +		 +

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

+
+ +## `TracingConfiguration` {#apiserver-k8s-io-v1beta1-TracingConfiguration} + +

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

+ + + + + + + + + + + + +
字段描述
apiVersion
string		apiserver.k8s.io/v1beta1
kind
string		TracingConfiguration
TracingConfiguration [必需]
+TracingConfiguration +		 + +（TracingConfiguration 的成员嵌入到这种类型中。） +

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

+
+ +## `Connection` {#apiserver-k8s-io-v1beta1-Connection} + + +**出现在：** + +- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection) + +

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

+ + + + + + + + + + + + +
字段描述
proxyProtocol [必需]
+ProtocolType +		 +

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

+
transport
+Transport +		 +

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

+
+ +## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection} + + +**出现在：** + +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) + +

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

+ + + + + + + + + + + + +
字段描述
name [必需]
+string +		 +

+ + name 是 Egress 选择算符的名称。当前支持的取值有 "controlplane"， + "master"，"etcd" 和 "cluster"。 + "master" Egress 选择算符已被弃用，推荐使用 "controlplane"。 +

+
connection [必需]
+Connection +		 +

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

+
+ +## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType} + + +（`string` 类型的别名） + +**出现在：** + +- [Connection](#apiserver-k8s-io-v1beta1-Connection) + +

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

+ +## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport} + + +**出现在：** + +- [Transport](#apiserver-k8s-io-v1beta1-Transport) + +

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

+ + + + + + + + + + + + +
字段描述
url [必需]
+string +		 +

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

+
tlsConfig
+TLSConfig +		 +

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

+
+ +## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig} + + +**出现在：** + +- [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport) + +

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

+ + + + + + + + + + + + + + + +
字段描述
caBundle
+string +		 +

+ + caBundle 是指向用来确定与 konnectivity 服务器间信任关系的 CA 证书包的文件位置。 + 如果 TCPTransport.URL 前缀为 "http://" 时必须不设置，或者设置为空。 + 如果 TCPTransport.URL 前缀为 "https://" 并且此字段未设置，则默认使用系统的信任根。 +

+
clientKey
+string +		 +

+ clientKey 是与 konnectivity 服务器进行 mtls 握手时使用的客户端秘钥文件位置。 + 如果 TCPTransport.URL 前缀为 http://，必须不指定或者为空； + 如果 TCPTransport.URL 前缀为 https://，必须设置。 +

+
clientCert
+string +		 +

+ + clientCert 是与 konnectivity 服务器进行 mtls 握手时使用的客户端证书文件位置。 + 如果 TCPTransport.URL 前缀为 http://，必须不指定或者为空； + 如果 TCPTransport.URL 前缀为 https://，必须设置。 +

+
+ +## `Transport` {#apiserver-k8s-io-v1beta1-Transport} + + +**出现在：** + +- [Connection](#apiserver-k8s-io-v1beta1-Connection) + +

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

+ + + + + + + + + + + + +
字段描述
tcp
+TCPTransport +		 +

+ + tcp 包含通过 TCP 与 konnectivity 服务器通信时使用的 TCP 配置。 + 目前使用 TCP 传输时不支持 GRPC 的 proxyProtocol。 + tcp 和 uds 二者至少设置一个。 +

+
uds
+UDSTransport +		 +

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

+
+ +## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport} + + +**出现在：** + +- [Transport](#apiserver-k8s-io-v1beta1-Transport) + +

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

+ + + + + + + + + +
字段描述
udsName [必需]
+string +		 +

+ + udsName 是与 konnectivity 服务器连接时使用的 UNIX 域套接字名称。 + 字段取值不要求包含 unix:// 前缀。 + （例如：/etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket） +

+
+ +## `TracingConfiguration` {#TracingConfiguration} + + +**出现在：** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + +- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration) + +- [TracingConfiguration](#apiserver-k8s-io-v1beta1-TracingConfiguration) + +

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

+ + + + + + + + + + + + +
FieldDescription
endpoint
+string +		 +

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

+
samplingRatePerMillion
+int32 +		 +

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

+
\ No newline at end of file