Skip to content

Commit 3ddd144

Browse files
authored
Merge pull request #30826 from tengqm/fix-configapi-123
Improve configuration API for 1.23
2 parents dffd3a8 + bce7fb5 commit 3ddd144

15 files changed

+1012
-3894
lines changed

content/en/docs/reference/_index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,16 @@ configure kubernetes components or tools. Most of these APIs are not exposed
7373
by the API server in a RESTful way though they are essential for a user or an
7474
operator to use or manage a cluster.
7575

76-
* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/)
77-
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/)
78-
* [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
79-
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/)
80-
* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/)
76+
77+
* [kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
78+
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
79+
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
80+
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) and
81+
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/)
8182
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
8283
* [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/)
83-
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
84+
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) and
85+
[Client authentication API (v1)](/docs/reference/config-api/client-authentication.v1/)
8486
* [WebhookAdmission configuration (v1)](/docs/reference/config-api/apiserver-webhookadmission.v1/)
8587

8688
## Config API for kubeadm

content/en/docs/reference/access-authn-authz/authentication.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1232,3 +1232,5 @@ The following `ExecCredential` manifest describes a cluster information sample.
12321232
## {{% heading "whatsnext" %}}
12331233

12341234
* Read the [client authentication reference (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
1235+
* Read the [client authentication reference (v1)](/docs/reference/config-api/client-authentication.v1/)
1236+

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

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,12 @@ auto_generated: true
1616

1717

1818

19-
2019
## `Event` {#audit-k8s-io-v1-Event}
2120

2221

2322

2423

2524
**Appears in:**
26-
2725
- [EventList](#audit-k8s-io-v1-EventList)
2826

2927

@@ -81,15 +79,15 @@ For non-resource requests, this is the lower-cased HTTP method.</td>
8179

8280

8381
<tr><td><code>user</code> <B>[Required]</B><br/>
84-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
82+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
8583
</td>
8684
<td>
8785
Authenticated user information.</td>
8886
</tr>
8987

9088

9189
<tr><td><code>impersonatedUser</code><br/>
92-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
90+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
9391
</td>
9492
<td>
9593
Impersonated user information.</td>
@@ -123,7 +121,7 @@ Does not apply for List-type requests, or non-resource requests.</td>
123121

124122

125123
<tr><td><code>responseStatus</code><br/>
126-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#status-v1-meta"><code>meta/v1.Status</code></a>
124+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta"><code>meta/v1.Status</code></a>
127125
</td>
128126
<td>
129127
The response status, populated even when the ResponseObject is not a Status type.
@@ -154,15 +152,15 @@ at Response Level.</td>
154152

155153

156154
<tr><td><code>requestReceivedTimestamp</code><br/>
157-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
155+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
158156
</td>
159157
<td>
160158
Time the request reached the apiserver.</td>
161159
</tr>
162160

163161

164162
<tr><td><code>stageTimestamp</code><br/>
165-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
163+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
166164
</td>
167165
<td>
168166
Time the request reached current audit stage.</td>
@@ -184,8 +182,6 @@ should be short. Annotations are included in the Metadata level.</td>
184182

185183
</tbody>
186184
</table>
187-
188-
189185

190186
## `EventList` {#audit-k8s-io-v1-EventList}
191187

@@ -206,7 +202,7 @@ EventList is a list of audit Events.
206202

207203

208204
<tr><td><code>metadata</code><br/>
209-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
205+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
210206
</td>
211207
<td>
212208
<span class="text-muted">No description provided.</span>
@@ -225,16 +221,13 @@ EventList is a list of audit Events.
225221

226222
</tbody>
227223
</table>
228-
229-
230224

231225
## `Policy` {#audit-k8s-io-v1-Policy}
232226

233227

234228

235229

236230
**Appears in:**
237-
238231
- [PolicyList](#audit-k8s-io-v1-PolicyList)
239232

240233

@@ -252,7 +245,7 @@ categories are logged.
252245

253246

254247
<tr><td><code>metadata</code><br/>
255-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
248+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
256249
</td>
257250
<td>
258251
ObjectMeta is included for interoperability with API infrastructure.Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
@@ -294,8 +287,6 @@ in a rule will override the global default.</td>
294287

295288
</tbody>
296289
</table>
297-
298-
299290

300291
## `PolicyList` {#audit-k8s-io-v1-PolicyList}
301292

@@ -316,7 +307,7 @@ PolicyList is a list of audit Policies.
316307

317308

318309
<tr><td><code>metadata</code><br/>
319-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
310+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
320311
</td>
321312
<td>
322313
<span class="text-muted">No description provided.</span>
@@ -335,16 +326,13 @@ PolicyList is a list of audit Policies.
335326

336327
</tbody>
337328
</table>
338-
339-
340329

341330
## `GroupResources` {#audit-k8s-io-v1-GroupResources}
342331

343332

344333

345334

346335
**Appears in:**
347-
348336
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
349337

350338

@@ -397,34 +385,27 @@ An empty list implies that every instance of the resource is matched.</td>
397385

398386
</tbody>
399387
</table>
400-
401-
402388

403389
## `Level` {#audit-k8s-io-v1-Level}
404390

405391
(Alias of `string`)
406392

407393

408394
**Appears in:**
409-
410395
- [Event](#audit-k8s-io-v1-Event)
411-
412396
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
413397

414398

415399
Level defines the amount of information logged during auditing
416400

417401

418-
419-
420402

421403
## `ObjectReference` {#audit-k8s-io-v1-ObjectReference}
422404

423405

424406

425407

426408
**Appears in:**
427-
428409
- [Event](#audit-k8s-io-v1-Event)
429410

430411

@@ -509,16 +490,13 @@ The empty string represents the core API group.</td>
509490

510491
</tbody>
511492
</table>
512-
513-
514493

515494
## `PolicyRule` {#audit-k8s-io-v1-PolicyRule}
516495

517496

518497

519498

520499
**Appears in:**
521-
522500
- [Policy](#audit-k8s-io-v1-Policy)
523501

524502

@@ -624,25 +602,19 @@ Policy.OmitManagedFields will stand.</td>
624602

625603
</tbody>
626604
</table>
627-
628-
629605

630606
## `Stage` {#audit-k8s-io-v1-Stage}
631607

632608
(Alias of `string`)
633609

634610

635611
**Appears in:**
636-
637612
- [Event](#audit-k8s-io-v1-Event)
638-
639613
- [Policy](#audit-k8s-io-v1-Policy)
640-
641614
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
642615

643616

644617
Stage defines the stages in request handling that audit events may be generated.
645618

646619

647-
648620

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: kube-apiserver Configuration (v1)
3+
content_type: tool-reference
4+
package: apiserver.config.k8s.io/v1
5+
auto_generated: true
6+
---
7+
Package v1 is the v1 version of the API.
8+
9+
## Resource Types
10+
11+
12+
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
13+
14+
15+
16+
## `AdmissionConfiguration` {#apiserver-config-k8s-io-v1-AdmissionConfiguration}
17+
18+
19+
20+
21+
22+
AdmissionConfiguration provides versioned configuration for admission controllers.
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.config.k8s.io/v1</code></td></tr>
29+
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
30+
31+
32+
33+
34+
<tr><td><code>plugins</code><br/>
35+
<a href="#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
36+
</td>
37+
<td>
38+
Plugins allows specifying a configuration per admission control plugin.</td>
39+
</tr>
40+
41+
42+
</tbody>
43+
</table>
44+
45+
## `AdmissionPluginConfiguration` {#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration}
46+
47+
48+
49+
50+
**Appears in:**
51+
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
52+
53+
54+
AdmissionPluginConfiguration provides the configuration for a single plug-in.
55+
56+
<table class="table">
57+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
58+
<tbody>
59+
60+
61+
62+
<tr><td><code>name</code> <B>[Required]</B><br/>
63+
<code>string</code>
64+
</td>
65+
<td>
66+
Name is the name of the admission controller.
67+
It must match the registered admission plugin name.</td>
68+
</tr>
69+
70+
71+
<tr><td><code>path</code><br/>
72+
<code>string</code>
73+
</td>
74+
<td>
75+
Path is the path to a configuration file that contains the plugin's
76+
configuration</td>
77+
</tr>
78+
79+
80+
<tr><td><code>configuration</code><br/>
81+
<a href="https://godoc.org/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a>
82+
</td>
83+
<td>
84+
Configuration is an embedded configuration object to be used as the plugin's
85+
configuration. If present, it will be used instead of the path to the configuration file.</td>
86+
</tr>
87+
88+
89+
</tbody>
90+
</table>
91+

0 commit comments

Comments
 (0)