Skip to content

Commit a5eeb33

Browse files
committed
Config API reference for 1.24
1 parent a8b640b commit a5eeb33

10 files changed

+1066
-1015
lines changed

content/en/docs/reference/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ operator to use or manage a cluster.
8080
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
8181
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
8282
* [kubelet credential providers (v1alpha1)](/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/)
83+
* [kubelet credential providers (v1beta1)](/docs/reference/config-api/kubelet-credentialprovider.v1beta1/)
8384
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) and
8485
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/)
8586
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)

content/en/docs/reference/config-api/apiserver-audit.v1.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,15 @@ For non-resource requests, this is the lower-cased HTTP method.</p>
8989
<code>[]string</code>
9090
</td>
9191
<td>
92-
<p>Source IPs, from where the request originated and intermediate proxies.</p>
92+
<p>Source IPs, from where the request originated and intermediate proxies.
93+
The source IPs are listed from (in order):</p>
94+
<ol>
95+
<li>X-Forwarded-For request header IPs</li>
96+
<li>X-Real-Ip header, if not present in the X-Forwarded-For list</li>
97+
<li>The remote address for the connection, if it doesn't match the last
98+
IP in the list up to here (X-Forwarded-For or X-Real-Ip).
99+
Note: All but the last IP can be arbitrarily set by the client.</li>
100+
</ol>
93101
</td>
94102
</tr>
95103
<tr><td><code>userAgent</code><br/>

content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,50 @@ An empty string slice is meant to select all network interfaces.</p>
193193
<p>DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR</p>
194194
</td>
195195
</tr>
196+
<tr><td><code>detectLocal</code> <B>[Required]</B><br/>
197+
<a href="#kubeproxy-config-k8s-io-v1alpha1-DetectLocalConfiguration"><code>DetectLocalConfiguration</code></a>
198+
</td>
199+
<td>
200+
<p>DetectLocal contains optional configuration settings related to DetectLocalMode.</p>
201+
</td>
202+
</tr>
203+
</tbody>
204+
</table>
205+
206+
## `DetectLocalConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-DetectLocalConfiguration}
207+
208+
209+
**Appears in:**
210+
211+
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
212+
213+
214+
<p>DetectLocalConfiguration contains optional settings related to DetectLocalMode option</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>bridgeInterface</code> <B>[Required]</B><br/>
223+
<code>string</code>
224+
</td>
225+
<td>
226+
<p>BridgeInterface is a string argument which represents a single bridge interface name.
227+
Kube-proxy considers traffic as local if originating from this given bridge.
228+
This argument should be set if DetectLocalMode is set to LocalModeBridgeInterface.</p>
229+
</td>
230+
</tr>
231+
<tr><td><code>interfaceNamePrefix</code> <B>[Required]</B><br/>
232+
<code>string</code>
233+
</td>
234+
<td>
235+
<p>InterfaceNamePrefix is a string argument which represents a single interface prefix name.
236+
Kube-proxy considers traffic as local if originating from one or more interfaces which match
237+
the given prefix. This argument should be set if DetectLocalMode is set to LocalModeInterfaceNamePrefix.</p>
238+
</td>
239+
</tr>
196240
</tbody>
197241
</table>
198242

@@ -424,6 +468,22 @@ NAT when loadbalancing</p>
424468
with DSR</p>
425469
</td>
426470
</tr>
471+
<tr><td><code>rootHnsEndpointName</code> <B>[Required]</B><br/>
472+
<code>string</code>
473+
</td>
474+
<td>
475+
<p>RootHnsEndpointName is the name of hnsendpoint that is attached to
476+
l2bridge for root network namespace</p>
477+
</td>
478+
</tr>
479+
<tr><td><code>forwardHealthCheckVip</code> <B>[Required]</B><br/>
480+
<code>bool</code>
481+
</td>
482+
<td>
483+
<p>ForwardHealthCheckVip forwards service VIP for health check port on
484+
Windows</p>
485+
</td>
486+
</tr>
427487
</tbody>
428488
</table>
429489

@@ -747,8 +807,9 @@ default value of format is <code>text</code></p>
747807
<a href="https://pkg.go.dev/time#Duration"><code>time.Duration</code></a>
748808
</td>
749809
<td>
750-
<p>Maximum number of seconds between log flushes. Ignored if the
751-
selected logging backend writes log messages without buffering.</p>
810+
<p>Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
811+
flushes. Ignored if the selected logging backend writes log
812+
messages without buffering.</p>
752813
</td>
753814
</tr>
754815
<tr><td><code>verbosity</code> <B>[Required]</B><br/>
@@ -769,14 +830,6 @@ are always logged.</p>
769830
Only supported for &quot;text&quot; log format.</p>
770831
</td>
771832
</tr>
772-
<tr><td><code>sanitization</code> <B>[Required]</B><br/>
773-
<code>bool</code>
774-
</td>
775-
<td>
776-
<p>[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
777-
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</p>
778-
</td>
779-
</tr>
780833
<tr><td><code>options</code> <B>[Required]</B><br/>
781834
<a href="#FormatOptions"><code>FormatOptions</code></a>
782835
</td>

content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,9 @@ default value of format is <code>text</code></p>
285285
<a href="https://pkg.go.dev/time#Duration"><code>time.Duration</code></a>
286286
</td>
287287
<td>
288-
<p>Maximum number of seconds between log flushes. Ignored if the
289-
selected logging backend writes log messages without buffering.</p>
288+
<p>Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
289+
flushes. Ignored if the selected logging backend writes log
290+
messages without buffering.</p>
290291
</td>
291292
</tr>
292293
<tr><td><code>verbosity</code> <B>[Required]</B><br/>
@@ -307,14 +308,6 @@ are always logged.</p>
307308
Only supported for &quot;text&quot; log format.</p>
308309
</td>
309310
</tr>
310-
<tr><td><code>sanitization</code> <B>[Required]</B><br/>
311-
<code>bool</code>
312-
</td>
313-
<td>
314-
<p>[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
315-
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</p>
316-
</td>
317-
</tr>
318311
<tr><td><code>options</code> <B>[Required]</B><br/>
319312
<a href="#FormatOptions"><code>FormatOptions</code></a>
320313
</td>
@@ -663,8 +656,7 @@ of &quot;System&quot; or &quot;List&quot;.</p>
663656
Nodes and Zones.</li>
664657
<li>&quot;List&quot;: Use constraints defined in .defaultConstraints.</li>
665658
</ul>
666-
<p>Defaults to &quot;List&quot; if feature gate DefaultPodTopologySpread is disabled
667-
and to &quot;System&quot; if enabled.</p>
659+
<p>Defaults to &quot;System&quot;.</p>
668660
</td>
669661
</tr>
670662
</tbody>

0 commit comments

Comments
 (0)