Skip to content

Commit f69f28f

Browse files
tengqmtengqm
committed
Update config API for v1.31
1 parent 5b0b301 commit f69f28f

15 files changed

+463
-187
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ requested. e.g. a patch can result in either a CREATE or UPDATE Operation.</p>
152152
</td>
153153
</tr>
154154
<tr><td><code>userInfo</code> <B>[Required]</B><br/>
155-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
155+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
156156
</td>
157157
<td>
158158
<p>UserInfo is information about the requesting user</p>
@@ -226,7 +226,7 @@ This must be copied over from the corresponding AdmissionRequest.</p>
226226
</td>
227227
</tr>
228228
<tr><td><code>status</code><br/>
229-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#status-v1-meta"><code>meta/v1.Status</code></a>
229+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#status-v1-meta"><code>meta/v1.Status</code></a>
230230
</td>
231231
<td>
232232
<p>Result contains extra details into why an admission request was denied.

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ For non-resource requests, this is the lower-cased HTTP method.</p>
7171
</td>
7272
</tr>
7373
<tr><td><code>user</code> <B>[Required]</B><br/>
74-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
74+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
7575
</td>
7676
<td>
7777
<p>Authenticated user information.</p>
7878
</td>
7979
</tr>
8080
<tr><td><code>impersonatedUser</code><br/>
81-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
81+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
8282
</td>
8383
<td>
8484
<p>Impersonated user information.</p>
@@ -116,7 +116,7 @@ Does not apply for List-type requests, or non-resource requests.</p>
116116
</td>
117117
</tr>
118118
<tr><td><code>responseStatus</code><br/>
119-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#status-v1-meta"><code>meta/v1.Status</code></a>
119+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#status-v1-meta"><code>meta/v1.Status</code></a>
120120
</td>
121121
<td>
122122
<p>The response status, populated even when the ResponseObject is not a Status type.
@@ -144,14 +144,14 @@ at Response Level.</p>
144144
</td>
145145
</tr>
146146
<tr><td><code>requestReceivedTimestamp</code><br/>
147-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
147+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
148148
</td>
149149
<td>
150150
<p>Time the request reached the apiserver.</p>
151151
</td>
152152
</tr>
153153
<tr><td><code>stageTimestamp</code><br/>
154-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
154+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
155155
</td>
156156
<td>
157157
<p>Time the request reached current audit stage.</p>
@@ -188,7 +188,7 @@ should be short. Annotations are included in the Metadata level.</p>
188188

189189

190190
<tr><td><code>metadata</code><br/>
191-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
191+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
192192
</td>
193193
<td>
194194
<span class="text-muted">No description provided.</span></td>
@@ -223,7 +223,7 @@ categories are logged.</p>
223223

224224

225225
<tr><td><code>metadata</code><br/>
226-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
226+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
227227
</td>
228228
<td>
229229
<p>ObjectMeta is included for interoperability with API infrastructure.</p>
@@ -278,7 +278,7 @@ in a rule will override the global default.</p>
278278

279279

280280
<tr><td><code>metadata</code><br/>
281-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
281+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
282282
</td>
283283
<td>
284284
<span class="text-muted">No description provided.</span></td>

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

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,17 @@ JWT authenticator will attempt to cryptographically validate the token.</p>
119119
&quot;iss&quot;: &quot;https://issuer.example.com&quot;,
120120
&quot;aud&quot;: [&quot;audience&quot;],
121121
&quot;exp&quot;: 1234567890,
122-
&quot;&lt;username claim&gt;&quot;: &quot;username&quot;
122+
&quot;<!-- raw HTML omitted -->&quot;: &quot;username&quot;
123123
}</p>
124124
</td>
125125
</tr>
126+
<tr><td><code>anonymous</code> <B>[Required]</B><br/>
127+
<a href="#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig"><code>AnonymousAuthConfig</code></a>
128+
</td>
129+
<td>
130+
<p>If present --anonymous-auth must not be set</p>
131+
</td>
132+
</tr>
126133
</tbody>
127134
</table>
128135

@@ -245,6 +252,66 @@ configuration. If present, it will be used instead of the path to the configurat
245252
</tbody>
246253
</table>
247254

255+
## `AnonymousAuthCondition` {#apiserver-k8s-io-v1alpha1-AnonymousAuthCondition}
256+
257+
258+
**Appears in:**
259+
260+
- [AnonymousAuthConfig](#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig)
261+
262+
263+
<p>AnonymousAuthCondition describes the condition under which anonymous auth
264+
should be enabled.</p>
265+
266+
267+
<table class="table">
268+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
269+
<tbody>
270+
271+
272+
<tr><td><code>path</code> <B>[Required]</B><br/>
273+
<code>string</code>
274+
</td>
275+
<td>
276+
<p>Path for which anonymous auth is enabled.</p>
277+
</td>
278+
</tr>
279+
</tbody>
280+
</table>
281+
282+
## `AnonymousAuthConfig` {#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig}
283+
284+
285+
**Appears in:**
286+
287+
- [AuthenticationConfiguration](#apiserver-k8s-io-v1alpha1-AuthenticationConfiguration)
288+
289+
290+
<p>AnonymousAuthConfig provides the configuration for the anonymous authenticator.</p>
291+
292+
293+
<table class="table">
294+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
295+
<tbody>
296+
297+
298+
<tr><td><code>enabled</code> <B>[Required]</B><br/>
299+
<code>bool</code>
300+
</td>
301+
<td>
302+
<span class="text-muted">No description provided.</span></td>
303+
</tr>
304+
<tr><td><code>conditions</code> <B>[Required]</B><br/>
305+
<a href="#apiserver-k8s-io-v1alpha1-AnonymousAuthCondition"><code>[]AnonymousAuthCondition</code></a>
306+
</td>
307+
<td>
308+
<p>If set, anonymous auth is only allowed if the request meets one of the
309+
conditions.</p>
310+
</td>
311+
</tr>
312+
</tbody>
313+
</table>
314+
248315
## `AudienceMatchPolicyType` {#apiserver-k8s-io-v1alpha1-AudienceMatchPolicyType}
249316

250317
(Alias of `string`)
@@ -331,7 +398,7 @@ The claim's value must be a singular string.
331398
Same as the --oidc-username-claim and --oidc-username-prefix flags.
332399
If username.expression is set, the expression must produce a string value.
333400
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
334-
username.expression or extra[&ast;].valueExpression or claimValidationRules[&ast;].expression.
401+
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
335402
An example claim validation rule expression that matches the validation automatically
336403
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.</p>
337404
<p>In the flag based approach, the --oidc-username-claim and --oidc-username-prefix are optional. If --oidc-username-claim is not set,
@@ -341,8 +408,8 @@ For prefix:
341408
(1) --oidc-username-prefix=&quot;-&quot;, no prefix was added to the username. For the same behavior using authentication config,
342409
set username.prefix=&quot;&quot;
343410
(2) --oidc-username-prefix=&quot;&quot; and --oidc-username-claim != &quot;email&quot;, prefix was &quot;&lt;value of --oidc-issuer-url&gt;#&quot;. For the same
344-
behavior using authentication config, set username.prefix=&quot;&lt;value of issuer.url&gt;#&quot;
345-
(3) --oidc-username-prefix=&quot;&lt;value&gt;&quot;. For the same behavior using authentication config, set username.prefix=&quot;&lt;value&gt;&quot;</p>
411+
behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->#&quot;
412+
(3) --oidc-username-prefix=&quot;<!-- raw HTML omitted -->&quot;. For the same behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->&quot;</p>
346413
</td>
347414
</tr>
348415
<tr><td><code>groups</code><br/>
@@ -1202,4 +1269,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
12021269
</tr>
12031270
</tbody>
12041271
</table>
1205-
1272+

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

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,17 @@ JWT authenticator will attempt to cryptographically validate the token.</p>
9595
&quot;iss&quot;: &quot;https://issuer.example.com&quot;,
9696
&quot;aud&quot;: [&quot;audience&quot;],
9797
&quot;exp&quot;: 1234567890,
98-
&quot;&lt;username claim&gt;&quot;: &quot;username&quot;
98+
&quot;<!-- raw HTML omitted -->&quot;: &quot;username&quot;
9999
}</p>
100100
</td>
101101
</tr>
102+
<tr><td><code>anonymous</code> <B>[Required]</B><br/>
103+
<a href="#apiserver-k8s-io-v1beta1-AnonymousAuthConfig"><code>AnonymousAuthConfig</code></a>
104+
</td>
105+
<td>
106+
<p>If present --anonymous-auth must not be set</p>
107+
</td>
108+
</tr>
102109
</tbody>
103110
</table>
104111

@@ -178,6 +185,66 @@ Must be at least one.</p>
178185
</tbody>
179186
</table>
180187

188+
## `AnonymousAuthCondition` {#apiserver-k8s-io-v1beta1-AnonymousAuthCondition}
189+
190+
191+
**Appears in:**
192+
193+
- [AnonymousAuthConfig](#apiserver-k8s-io-v1beta1-AnonymousAuthConfig)
194+
195+
196+
<p>AnonymousAuthCondition describes the condition under which anonymous auth
197+
should be enabled.</p>
198+
199+
200+
<table class="table">
201+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
202+
<tbody>
203+
204+
205+
<tr><td><code>path</code> <B>[Required]</B><br/>
206+
<code>string</code>
207+
</td>
208+
<td>
209+
<p>Path for which anonymous auth is enabled.</p>
210+
</td>
211+
</tr>
212+
</tbody>
213+
</table>
214+
215+
## `AnonymousAuthConfig` {#apiserver-k8s-io-v1beta1-AnonymousAuthConfig}
216+
217+
218+
**Appears in:**
219+
220+
- [AuthenticationConfiguration](#apiserver-k8s-io-v1beta1-AuthenticationConfiguration)
221+
222+
223+
<p>AnonymousAuthConfig provides the configuration for the anonymous authenticator.</p>
224+
225+
226+
<table class="table">
227+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
228+
<tbody>
229+
230+
231+
<tr><td><code>enabled</code> <B>[Required]</B><br/>
232+
<code>bool</code>
233+
</td>
234+
<td>
235+
<span class="text-muted">No description provided.</span></td>
236+
</tr>
237+
<tr><td><code>conditions</code> <B>[Required]</B><br/>
238+
<a href="#apiserver-k8s-io-v1beta1-AnonymousAuthCondition"><code>[]AnonymousAuthCondition</code></a>
239+
</td>
240+
<td>
241+
<p>If set, anonymous auth is only allowed if the request meets one of the
242+
conditions.</p>
243+
</td>
244+
</tr>
245+
</tbody>
246+
</table>
247+
181248
## `AudienceMatchPolicyType` {#apiserver-k8s-io-v1beta1-AudienceMatchPolicyType}
182249

183250
(Alias of `string`)
@@ -264,7 +331,7 @@ The claim's value must be a singular string.
264331
Same as the --oidc-username-claim and --oidc-username-prefix flags.
265332
If username.expression is set, the expression must produce a string value.
266333
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
267-
username.expression or extra[&ast;].valueExpression or claimValidationRules[&ast;].expression.
334+
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
268335
An example claim validation rule expression that matches the validation automatically
269336
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.</p>
270337
<p>In the flag based approach, the --oidc-username-claim and --oidc-username-prefix are optional. If --oidc-username-claim is not set,
@@ -274,8 +341,8 @@ For prefix:
274341
(1) --oidc-username-prefix=&quot;-&quot;, no prefix was added to the username. For the same behavior using authentication config,
275342
set username.prefix=&quot;&quot;
276343
(2) --oidc-username-prefix=&quot;&quot; and --oidc-username-claim != &quot;email&quot;, prefix was &quot;&lt;value of --oidc-issuer-url&gt;#&quot;. For the same
277-
behavior using authentication config, set username.prefix=&quot;&lt;value of issuer.url&gt;#&quot;
278-
(3) --oidc-username-prefix=&quot;&lt;value&gt;&quot;. For the same behavior using authentication config, set username.prefix=&quot;&lt;value&gt;&quot;</p>
344+
behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->#&quot;
345+
(3) --oidc-username-prefix=&quot;<!-- raw HTML omitted -->&quot;. For the same behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->&quot;</p>
279346
</td>
280347
</tr>
281348
<tr><td><code>groups</code><br/>
@@ -1135,4 +1202,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
11351202
</tr>
11361203
</tbody>
11371204
</table>
1138-
1205+

‎content/en/docs/reference/config-api/client-authentication.v1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ itself should at least be protected via file permissions.</p>
205205

206206

207207
<tr><td><code>expirationTimestamp</code><br/>
208-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#time-v1-meta"><code>meta/v1.Time</code></a>
208+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta"><code>meta/v1.Time</code></a>
209209
</td>
210210
<td>
211211
<p>ExpirationTimestamp indicates a time when the provided credentials expire.</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ itself should at least be protected via file permissions.</p>
205205

206206

207207
<tr><td><code>expirationTimestamp</code><br/>
208-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#time-v1-meta"><code>meta/v1.Time</code></a>
208+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta"><code>meta/v1.Time</code></a>
209209
</td>
210210
<td>
211211
<p>ExpirationTimestamp indicates a time when the provided credentials expire.</p>

‎content/en/docs/reference/config-api/imagepolicy.v1alpha1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ auto_generated: true
2828

2929

3030
<tr><td><code>metadata</code><br/>
31-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
31+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
3232
</td>
3333
<td>
3434
<p>Standard object's metadata.

‎content/en/docs/reference/config-api/kube-controller-manager-config.v1alpha1.md‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1256,13 +1256,6 @@ Larger number = more responsive HPA processing, but more CPU (and network) load.
12561256
pods in horizontal pod autoscaler.</p>
12571257
</td>
12581258
</tr>
1259-
<tr><td><code>HorizontalPodAutoscalerUpscaleForbiddenWindow</code> <B>[Required]</B><br/>
1260-
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
1261-
</td>
1262-
<td>
1263-
<p>HorizontalPodAutoscalerUpscaleForbiddenWindow is a period after which next upscale allowed.</p>
1264-
</td>
1265-
</tr>
12661259
<tr><td><code>HorizontalPodAutoscalerDownscaleStabilizationWindow</code> <B>[Required]</B><br/>
12671260
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
12681261
</td>
@@ -1271,13 +1264,6 @@ pods in horizontal pod autoscaler.</p>
12711264
backwards and not scale down below any recommendation it made during that period.</p>
12721265
</td>
12731266
</tr>
1274-
<tr><td><code>HorizontalPodAutoscalerDownscaleForbiddenWindow</code> <B>[Required]</B><br/>
1275-
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
1276-
</td>
1277-
<td>
1278-
<p>HorizontalPodAutoscalerDownscaleForbiddenWindow is a period after which next downscale allowed.</p>
1279-
</td>
1280-
</tr>
12811267
<tr><td><code>HorizontalPodAutoscalerTolerance</code> <B>[Required]</B><br/>
12821268
<code>float64</code>
12831269
</td>
@@ -1556,22 +1542,6 @@ and persistent volume claims.</p>
15561542
<p>volumeConfiguration holds configuration for volume related features.</p>
15571543
</td>
15581544
</tr>
1559-
<tr><td><code>VolumeHostCIDRDenylist</code> <B>[Required]</B><br/>
1560-
<code>[]string</code>
1561-
</td>
1562-
<td>
1563-
<p>DEPRECATED: VolumeHostCIDRDenylist is a list of CIDRs that should not be reachable by the
1564-
controller from plugins.</p>
1565-
</td>
1566-
</tr>
1567-
<tr><td><code>VolumeHostAllowLocalLoopback</code> <B>[Required]</B><br/>
1568-
<code>bool</code>
1569-
</td>
1570-
<td>
1571-
<p>DEPRECATED: VolumeHostAllowLocalLoopback indicates if local loopback hosts (127.0.0.1, etc)
1572-
should be allowed from plugins.</p>
1573-
</td>
1574-
</tr>
15751545
</tbody>
15761546
</table>
15771547

0 commit comments

Comments
 (0)