From bd368eef02b0a391304350cf42a3daa18984d598 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Mon, 27 Mar 2023 14:59:11 +0800 Subject: [PATCH] Add config API for apiserver config v1beta1 --- content/en/docs/reference/_index.md | 1 + .../config-api/apiserver-config.v1beta1.md | 268 ++++++++++++++++++ 2 files changed, 269 insertions(+) create mode 100644 content/en/docs/reference/config-api/apiserver-config.v1beta1.md diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index a24535ba0ce..960881e77f0 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -77,6 +77,7 @@ operator to use or manage a cluster. * [kubeconfig (v1)](/docs/reference/config-api/kubeconfig.v1/) * [kube-apiserver admission (v1)](/docs/reference/config-api/apiserver-admission.v1/) * [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and +* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and [kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/) * [kube-apiserver encryption (v1)](/docs/reference/config-api/apiserver-encryption.v1/) * [kube-apiserver event rate limit (v1alpha1)](/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/) diff --git a/content/en/docs/reference/config-api/apiserver-config.v1beta1.md b/content/en/docs/reference/config-api/apiserver-config.v1beta1.md new file mode 100644 index 00000000000..0ed8e17a44d --- /dev/null +++ b/content/en/docs/reference/config-api/apiserver-config.v1beta1.md @@ -0,0 +1,268 @@ +--- +title: kube-apiserver Configuration (v1beta1) +content_type: tool-reference +package: apiserver.k8s.io/v1beta1 +auto_generated: true +--- +

Package v1beta1 is the v1beta1 version of the API.

+ + +## Resource Types + + +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) + + + +## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration} + + + +

EgressSelectorConfiguration provides versioned configuration for egress selector clients.

+ + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		apiserver.k8s.io/v1beta1
kind
string		EgressSelectorConfiguration
egressSelections [Required]
+[]EgressSelection +		 +

connectionServices contains a list of egress selection client configurations

+
+ +## `Connection` {#apiserver-k8s-io-v1beta1-Connection} + + +**Appears in:** + +- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection) + + +

Connection provides the configuration for a single egress selection client.

+ + + + + + + + + + + + + + +
FieldDescription
proxyProtocol [Required]
+ProtocolType +		 +

Protocol is the protocol used to connect from client to the konnectivity server.

+
transport
+Transport +		 +

Transport defines the transport configurations we use to dial to the konnectivity server. +This is required if ProxyProtocol is HTTPConnect or GRPC.

+
+ +## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection} + + +**Appears in:** + +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) + + +

EgressSelection provides the configuration for a single egress selection client.

+ + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 +

name is the name of the egress selection. +Currently supported values are "controlplane", "master", "etcd" and "cluster" +The "master" egress selector is deprecated in favor of "controlplane"

+
connection [Required]
+Connection +		 +

connection is the exact information used to configure the egress selection

+
+ +## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType} + +(Alias of `string`) + +**Appears in:** + +- [Connection](#apiserver-k8s-io-v1beta1-Connection) + + +

ProtocolType is a set of valid values for Connection.ProtocolType

+ + + + +## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport} + + +**Appears in:** + +- [Transport](#apiserver-k8s-io-v1beta1-Transport) + + +

TCPTransport provides the information to connect to konnectivity server via TCP

+ + + + + + + + + + + + + + +
FieldDescription
url [Required]
+string +		 +

URL is the location of the konnectivity server to connect to. +As an example it might be "https://127.0.0.1:8131"

+
tlsConfig
+TLSConfig +		 +

TLSConfig is the config needed to use TLS when connecting to konnectivity server

+
+ +## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig} + + +**Appears in:** + +- [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport) + + +

TLSConfig provides the authentication information to connect to konnectivity server +Only used with TCPTransport

+ + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
+string +		 +

caBundle is the file location of the CA to be used to determine trust with the konnectivity server. +Must be absent/empty if TCPTransport.URL is prefixed with http:// +If absent while TCPTransport.URL is prefixed with https://, default to system trust roots.

+
clientKey
+string +		 +

clientKey is the file location of the client key to be used in mtls handshakes with the konnectivity server. +Must be absent/empty if TCPTransport.URL is prefixed with http:// +Must be configured if TCPTransport.URL is prefixed with https://

+
clientCert
+string +		 +

clientCert is the file location of the client certificate to be used in mtls handshakes with the konnectivity server. +Must be absent/empty if TCPTransport.URL is prefixed with http:// +Must be configured if TCPTransport.URL is prefixed with https://

+
+ +## `Transport` {#apiserver-k8s-io-v1beta1-Transport} + + +**Appears in:** + +- [Connection](#apiserver-k8s-io-v1beta1-Connection) + + +

Transport defines the transport configurations we use to dial to the konnectivity server

+ + + + + + + + + + + + + + +
FieldDescription
tcp
+TCPTransport +		 +

TCP is the TCP configuration for communicating with the konnectivity server via TCP +ProxyProtocol of GRPC is not supported with TCP transport at the moment +Requires at least one of TCP or UDS to be set

+
uds
+UDSTransport +		 +

UDS is the UDS configuration for communicating with the konnectivity server via UDS +Requires at least one of TCP or UDS to be set

+
+ +## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport} + + +**Appears in:** + +- [Transport](#apiserver-k8s-io-v1beta1-Transport) + + +

UDSTransport provides the information to connect to konnectivity server via UDS

+ + + + + + + + + + + +
FieldDescription
udsName [Required]
+string +		 +

UDSName is the name of the unix domain socket to connect to konnectivity server +This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket)

+
+ \ No newline at end of file