From 07fb0c1a6de5170fd2f456b081841c2c72881a04 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Sun, 27 Feb 2022 17:58:29 +0800 Subject: [PATCH] [zh] Translate API server config v1alpha1 reference --- .../config-api/apiserver-config.v1alpha1.md | 447 ++++++++++++++++++ 1 file changed, 447 insertions(+) create mode 100644 content/zh/docs/reference/config-api/apiserver-config.v1alpha1.md diff --git a/content/zh/docs/reference/config-api/apiserver-config.v1alpha1.md b/content/zh/docs/reference/config-api/apiserver-config.v1alpha1.md new file mode 100644 index 0000000000..b399f304e3 --- /dev/null +++ b/content/zh/docs/reference/config-api/apiserver-config.v1alpha1.md @@ -0,0 +1,447 @@ +--- +title: kube-apiserver 配置 (v1alpha1) +content_type: tool-reference +package: apiserver.k8s.io/v1alpha1 +auto_generated: true +--- + + +

包 v1alpha1 包含 API 的 v1alpha1 版本。

+ + +## 资源类型 + +- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration) +- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration) + +## `AdmissionConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionConfiguration} + +

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

+ + + + + + + + + + + + +
字段描述
apiVersion
string		apiserver.k8s.io/v1alpha1
kind
string		AdmissionConfiguration
plugins
+[]AdmissionPluginConfiguration +		 +

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

+
+ +## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration} + +

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

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

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

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

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

+ + + + + + + + + + + + + + + +
字段描述
apiVersion
string		apiserver.k8s.io/v1alpha1
kind
string		TracingConfiguration
endpoint
+string +		 +

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

+
samplingRatePerMillion
+int32 +		 +

+ samplingRatePerMillion 设置每一百万个数据点中要采样的样本个数。默认值为 0。 +

+
+ +## `AdmissionPluginConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration} + + +**出现在：** + +- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) + +

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

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

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

+
path
+string +		 +

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

+
configuration
+k8s.io/apimachinery/pkg/runtime.Unknown +		 +

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

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

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

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

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

+
transport
+Transport +		 +

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

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

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

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

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

+
connection [必需]
+Connection +		 +

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

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

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

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

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

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

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

+
tlsConfig
+TLSConfig +		 +

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

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

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

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

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

+
clientKey
+string +		 +

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

+
clientCert
+string +		 +

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

+
+ +## `Transport` {#apiserver-k8s-io-v1alpha1-Transport} + + +**出现在：** + +- [Connection](#apiserver-k8s-io-v1alpha1-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-v1alpha1-UDSTransport} + + +**出现在：** + +- [Transport](#apiserver-k8s-io-v1alpha1-Transport) + +

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

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

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

+
+