Skip to content

Commit d42d781

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #40330 from tengqm/add-apiserver-v1beta1
Add apiserver v1beta1
2 parents 59339a1 + bd368ee commit d42d781

File tree

2 files changed

+269
-0
lines changed

2 files changed

+269
-0
lines changed

‎content/en/docs/reference/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ operator to use or manage a cluster.
7777
* [kubeconfig (v1)](/docs/reference/config-api/kubeconfig.v1/)
7878
* [kube-apiserver admission (v1)](/docs/reference/config-api/apiserver-admission.v1/)
7979
* [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and
80+
* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and
8081
[kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
8182
* [kube-apiserver encryption (v1)](/docs/reference/config-api/apiserver-encryption.v1/)
8283
* [kube-apiserver event rate limit (v1alpha1)](/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)

‎content/en/docs/reference/config-api/apiserver-config.v1beta1.md

Lines changed: 268 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
---
2+
title: kube-apiserver Configuration (v1beta1)
3+
content_type: tool-reference
4+
package: apiserver.k8s.io/v1beta1
5+
auto_generated: true
6+
---
7+
<p>Package v1beta1 is the v1beta1 version of the API.</p>
8+
9+
10+
## Resource Types
11+
12+
13+
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
14+
15+
16+
17+
## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration}
18+
19+
20+
21+
<p>EgressSelectorConfiguration provides versioned configuration for egress selector clients.</p>
22+
23+
24+
<table class="table">
25+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
26+
<tbody>
27+
28+
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1beta1</code></td></tr>
29+
<tr><td><code>kind</code><br/>string</td><td><code>EgressSelectorConfiguration</code></td></tr>
30+
31+
32+
<tr><td><code>egressSelections</code> <B>[Required]</B><br/>
33+
<a href="#apiserver-k8s-io-v1beta1-EgressSelection"><code>[]EgressSelection</code></a>
34+
</td>
35+
<td>
36+
<p>connectionServices contains a list of egress selection client configurations</p>
37+
</td>
38+
</tr>
39+
</tbody>
40+
</table>
41+
42+
## `Connection` {#apiserver-k8s-io-v1beta1-Connection}
43+
44+
45+
**Appears in:**
46+
47+
- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection)
48+
49+
50+
<p>Connection provides the configuration for a single egress selection client.</p>
51+
52+
53+
<table class="table">
54+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
55+
<tbody>
56+
57+
58+
<tr><td><code>proxyProtocol</code> <B>[Required]</B><br/>
59+
<a href="#apiserver-k8s-io-v1beta1-ProtocolType"><code>ProtocolType</code></a>
60+
</td>
61+
<td>
62+
<p>Protocol is the protocol used to connect from client to the konnectivity server.</p>
63+
</td>
64+
</tr>
65+
<tr><td><code>transport</code><br/>
66+
<a href="#apiserver-k8s-io-v1beta1-Transport"><code>Transport</code></a>
67+
</td>
68+
<td>
69+
<p>Transport defines the transport configurations we use to dial to the konnectivity server.
70+
This is required if ProxyProtocol is HTTPConnect or GRPC.</p>
71+
</td>
72+
</tr>
73+
</tbody>
74+
</table>
75+
76+
## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection}
77+
78+
79+
**Appears in:**
80+
81+
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
82+
83+
84+
<p>EgressSelection provides the configuration for a single egress selection client.</p>
85+
86+
87+
<table class="table">
88+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
89+
<tbody>
90+
91+
92+
<tr><td><code>name</code> <B>[Required]</B><br/>
93+
<code>string</code>
94+
</td>
95+
<td>
96+
<p>name is the name of the egress selection.
97+
Currently supported values are &quot;controlplane&quot;, &quot;master&quot;, &quot;etcd&quot; and &quot;cluster&quot;
98+
The &quot;master&quot; egress selector is deprecated in favor of &quot;controlplane&quot;</p>
99+
</td>
100+
</tr>
101+
<tr><td><code>connection</code> <B>[Required]</B><br/>
102+
<a href="#apiserver-k8s-io-v1beta1-Connection"><code>Connection</code></a>
103+
</td>
104+
<td>
105+
<p>connection is the exact information used to configure the egress selection</p>
106+
</td>
107+
</tr>
108+
</tbody>
109+
</table>
110+
111+
## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType}
112+
113+
(Alias of `string`)
114+
115+
**Appears in:**
116+
117+
- [Connection](#apiserver-k8s-io-v1beta1-Connection)
118+
119+
120+
<p>ProtocolType is a set of valid values for Connection.ProtocolType</p>
121+
122+
123+
124+
125+
## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport}
126+
127+
128+
**Appears in:**
129+
130+
- [Transport](#apiserver-k8s-io-v1beta1-Transport)
131+
132+
133+
<p>TCPTransport provides the information to connect to konnectivity server via TCP</p>
134+
135+
136+
<table class="table">
137+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
138+
<tbody>
139+
140+
141+
<tr><td><code>url</code> <B>[Required]</B><br/>
142+
<code>string</code>
143+
</td>
144+
<td>
145+
<p>URL is the location of the konnectivity server to connect to.
146+
As an example it might be &quot;https://127.0.0.1:8131&quot;</p>
147+
</td>
148+
</tr>
149+
<tr><td><code>tlsConfig</code><br/>
150+
<a href="#apiserver-k8s-io-v1beta1-TLSConfig"><code>TLSConfig</code></a>
151+
</td>
152+
<td>
153+
<p>TLSConfig is the config needed to use TLS when connecting to konnectivity server</p>
154+
</td>
155+
</tr>
156+
</tbody>
157+
</table>
158+
159+
## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig}
160+
161+
162+
**Appears in:**
163+
164+
- [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport)
165+
166+
167+
<p>TLSConfig provides the authentication information to connect to konnectivity server
168+
Only used with TCPTransport</p>
169+
170+
171+
<table class="table">
172+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
173+
<tbody>
174+
175+
176+
<tr><td><code>caBundle</code><br/>
177+
<code>string</code>
178+
</td>
179+
<td>
180+
<p>caBundle is the file location of the CA to be used to determine trust with the konnectivity server.
181+
Must be absent/empty if TCPTransport.URL is prefixed with http://
182+
If absent while TCPTransport.URL is prefixed with https://, default to system trust roots.</p>
183+
</td>
184+
</tr>
185+
<tr><td><code>clientKey</code><br/>
186+
<code>string</code>
187+
</td>
188+
<td>
189+
<p>clientKey is the file location of the client key to be used in mtls handshakes with the konnectivity server.
190+
Must be absent/empty if TCPTransport.URL is prefixed with http://
191+
Must be configured if TCPTransport.URL is prefixed with https://</p>
192+
</td>
193+
</tr>
194+
<tr><td><code>clientCert</code><br/>
195+
<code>string</code>
196+
</td>
197+
<td>
198+
<p>clientCert is the file location of the client certificate to be used in mtls handshakes with the konnectivity server.
199+
Must be absent/empty if TCPTransport.URL is prefixed with http://
200+
Must be configured if TCPTransport.URL is prefixed with https://</p>
201+
</td>
202+
</tr>
203+
</tbody>
204+
</table>
205+
206+
## `Transport` {#apiserver-k8s-io-v1beta1-Transport}
207+
208+
209+
**Appears in:**
210+
211+
- [Connection](#apiserver-k8s-io-v1beta1-Connection)
212+
213+
214+
<p>Transport defines the transport configurations we use to dial to the konnectivity server</p>
215+
216+
217+
<table class="table">
218+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
219+
<tbody>
220+
221+
222+
<tr><td><code>tcp</code><br/>
223+
<a href="#apiserver-k8s-io-v1beta1-TCPTransport"><code>TCPTransport</code></a>
224+
</td>
225+
<td>
226+
<p>TCP is the TCP configuration for communicating with the konnectivity server via TCP
227+
ProxyProtocol of GRPC is not supported with TCP transport at the moment
228+
Requires at least one of TCP or UDS to be set</p>
229+
</td>
230+
</tr>
231+
<tr><td><code>uds</code><br/>
232+
<a href="#apiserver-k8s-io-v1beta1-UDSTransport"><code>UDSTransport</code></a>
233+
</td>
234+
<td>
235+
<p>UDS is the UDS configuration for communicating with the konnectivity server via UDS
236+
Requires at least one of TCP or UDS to be set</p>
237+
</td>
238+
</tr>
239+
</tbody>
240+
</table>
241+
242+
## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport}
243+
244+
245+
**Appears in:**
246+
247+
- [Transport](#apiserver-k8s-io-v1beta1-Transport)
248+
249+
250+
<p>UDSTransport provides the information to connect to konnectivity server via UDS</p>
251+
252+
253+
<table class="table">
254+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
255+
<tbody>
256+
257+
258+
<tr><td><code>udsName</code> <B>[Required]</B><br/>
259+
<code>string</code>
260+
</td>
261+
<td>
262+
<p>UDSName is the name of the unix domain socket to connect to konnectivity server
263+
This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket)</p>
264+
</td>
265+
</tr>
266+
</tbody>
267+
</table>
268+

0 commit comments

Comments
 (0)