Skip to content

Commit efb0246

Browse files
tengqmtengqm
committed
Update config API reference for v1.35 release
1 parent 79c15bf commit efb0246

14 files changed

Lines changed: 526 additions & 78 deletions

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ auto_generated: true
3131
<a href="#admission-k8s-io-v1-AdmissionRequest"><code>AdmissionRequest</code></a>
3232
</td>
3333
<td>
34-
<p>Request describes the attributes for the admission request.</p>
34+
<p>request describes the attributes for the admission request.</p>
3535
</td>
3636
</tr>
3737
<tr><td><code>response</code><br/>
3838
<a href="#admission-k8s-io-v1-AdmissionResponse"><code>AdmissionResponse</code></a>
3939
</td>
4040
<td>
41-
<p>Response describes the attributes for the admission response.</p>
41+
<p>response describes the attributes for the admission response.</p>
4242
</td>
4343
</tr>
4444
</tbody>
@@ -64,7 +64,7 @@ auto_generated: true
6464
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
6565
</td>
6666
<td>
67-
<p>UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
67+
<p>uid is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
6868
otherwise identical (parallel requests, requests when earlier requests did not modify etc)
6969
The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request.
7070
It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.</p>
@@ -74,28 +74,28 @@ It is suitable for correlating log entries between the webhook and apiserver, fo
7474
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind"><code>meta/v1.GroupVersionKind</code></a>
7575
</td>
7676
<td>
77-
<p>Kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)</p>
77+
<p>kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)</p>
7878
</td>
7979
</tr>
8080
<tr><td><code>resource</code> <B>[Required]</B><br/>
8181
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource"><code>meta/v1.GroupVersionResource</code></a>
8282
</td>
8383
<td>
84-
<p>Resource is the fully-qualified resource being requested (for example, v1.pods)</p>
84+
<p>resource is the fully-qualified resource being requested (for example, v1.pods)</p>
8585
</td>
8686
</tr>
8787
<tr><td><code>subResource</code><br/>
8888
<code>string</code>
8989
</td>
9090
<td>
91-
<p>SubResource is the subresource being requested, if any (for example, &quot;status&quot; or &quot;scale&quot;)</p>
91+
<p>subResource is the subresource being requested, if any (for example, &quot;status&quot; or &quot;scale&quot;)</p>
9292
</td>
9393
</tr>
9494
<tr><td><code>requestKind</code><br/>
9595
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind"><code>meta/v1.GroupVersionKind</code></a>
9696
</td>
9797
<td>
98-
<p>RequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
98+
<p>requestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
9999
If this is specified and differs from the value in &quot;kind&quot;, an equivalent match and conversion was performed.</p>
100100
<p>For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
101101
<code>apiGroups:[&quot;apps&quot;], apiVersions:[&quot;v1&quot;], resources: [&quot;deployments&quot;]</code> and <code>matchPolicy: Equivalent</code>,
@@ -109,7 +109,7 @@ and <code>requestKind: {group:&quot;apps&quot;, version:&quot;v1beta1&quot;, kin
109109
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource"><code>meta/v1.GroupVersionResource</code></a>
110110
</td>
111111
<td>
112-
<p>RequestResource is the fully-qualified resource of the original API request (for example, v1.pods).
112+
<p>requestResource is the fully-qualified resource of the original API request (for example, v1.pods).
113113
If this is specified and differs from the value in &quot;resource&quot;, an equivalent match and conversion was performed.</p>
114114
<p>For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
115115
<code>apiGroups:[&quot;apps&quot;], apiVersions:[&quot;v1&quot;], resources: [&quot;deployments&quot;]</code> and <code>matchPolicy: Equivalent</code>,
@@ -123,7 +123,7 @@ and <code>requestResource: {group:&quot;apps&quot;, version:&quot;v1beta1&quot;,
123123
<code>string</code>
124124
</td>
125125
<td>
126-
<p>RequestSubResource is the name of the subresource of the original API request, if any (for example, &quot;status&quot; or &quot;scale&quot;)
126+
<p>requestSubResource is the name of the subresource of the original API request, if any (for example, &quot;status&quot; or &quot;scale&quot;)
127127
If this is specified and differs from the value in &quot;subResource&quot;, an equivalent match and conversion was performed.
128128
See documentation for the &quot;matchPolicy&quot; field in the webhook configuration type.</p>
129129
</td>
@@ -132,59 +132,59 @@ See documentation for the &quot;matchPolicy&quot; field in the webhook configura
132132
<code>string</code>
133133
</td>
134134
<td>
135-
<p>Name is the name of the object as presented in the request. On a CREATE operation, the client may omit name and
135+
<p>name is the name of the object as presented in the request. On a CREATE operation, the client may omit name and
136136
rely on the server to generate the name. If that is the case, this field will contain an empty string.</p>
137137
</td>
138138
</tr>
139139
<tr><td><code>namespace</code><br/>
140140
<code>string</code>
141141
</td>
142142
<td>
143-
<p>Namespace is the namespace associated with the request (if any).</p>
143+
<p>namespace is the namespace associated with the request (if any).</p>
144144
</td>
145145
</tr>
146146
<tr><td><code>operation</code> <B>[Required]</B><br/>
147147
<a href="#admission-k8s-io-v1-Operation"><code>Operation</code></a>
148148
</td>
149149
<td>
150-
<p>Operation is the operation being performed. This may be different than the operation
150+
<p>operation is the operation being performed. This may be different than the operation
151151
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.34/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
155+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
156156
</td>
157157
<td>
158-
<p>UserInfo is information about the requesting user</p>
158+
<p>userInfo is information about the requesting user</p>
159159
</td>
160160
</tr>
161161
<tr><td><code>object</code><br/>
162162
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
163163
</td>
164164
<td>
165-
<p>Object is the object from the incoming request.</p>
165+
<p>object is the object from the incoming request.</p>
166166
</td>
167167
</tr>
168168
<tr><td><code>oldObject</code><br/>
169169
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
170170
</td>
171171
<td>
172-
<p>OldObject is the existing object. Only populated for DELETE and UPDATE requests.</p>
172+
<p>oldObject is the existing object. Only populated for DELETE and UPDATE requests.</p>
173173
</td>
174174
</tr>
175175
<tr><td><code>dryRun</code><br/>
176176
<code>bool</code>
177177
</td>
178178
<td>
179-
<p>DryRun indicates that modifications will definitely not be persisted for this request.
179+
<p>dryRun indicates that modifications will definitely not be persisted for this request.
180180
Defaults to false.</p>
181181
</td>
182182
</tr>
183183
<tr><td><code>options</code><br/>
184184
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
185185
</td>
186186
<td>
187-
<p>Options is the operation option structure of the operation being performed.
187+
<p>options is the operation option structure of the operation being performed.
188188
e.g. <code>meta.k8s.io/v1.DeleteOptions</code> or <code>meta.k8s.io/v1.CreateOptions</code>. This may be
189189
different than the options the caller provided. e.g. for a patch request the performed
190190
Operation might be a CREATE, in which case the Options will a
@@ -214,44 +214,44 @@ Operation might be a CREATE, in which case the Options will a
214214
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
215215
</td>
216216
<td>
217-
<p>UID is an identifier for the individual request/response.
217+
<p>uid is an identifier for the individual request/response.
218218
This must be copied over from the corresponding AdmissionRequest.</p>
219219
</td>
220220
</tr>
221221
<tr><td><code>allowed</code> <B>[Required]</B><br/>
222222
<code>bool</code>
223223
</td>
224224
<td>
225-
<p>Allowed indicates whether or not the admission request was permitted.</p>
225+
<p>allowed indicates whether or not the admission request was permitted.</p>
226226
</td>
227227
</tr>
228228
<tr><td><code>status</code><br/>
229-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#status-v1-meta"><code>meta/v1.Status</code></a>
229+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#status-v1-meta"><code>meta/v1.Status</code></a>
230230
</td>
231231
<td>
232-
<p>Result contains extra details into why an admission request was denied.
232+
<p>status is the result contains extra details into why an admission request was denied.
233233
This field IS NOT consulted in any way if &quot;Allowed&quot; is &quot;true&quot;.</p>
234234
</td>
235235
</tr>
236236
<tr><td><code>patch</code><br/>
237237
<code>[]byte</code>
238238
</td>
239239
<td>
240-
<p>The patch body. Currently we only support &quot;JSONPatch&quot; which implements RFC 6902.</p>
240+
<p>patch is the patch body. Currently we only support &quot;JSONPatch&quot; which implements RFC 6902.</p>
241241
</td>
242242
</tr>
243243
<tr><td><code>patchType</code><br/>
244244
<a href="#admission-k8s-io-v1-PatchType"><code>PatchType</code></a>
245245
</td>
246246
<td>
247-
<p>The type of Patch. Currently we only allow &quot;JSONPatch&quot;.</p>
247+
<p>patchType is the type of Patch. Currently we only allow &quot;JSONPatch&quot;.</p>
248248
</td>
249249
</tr>
250250
<tr><td><code>auditAnnotations</code><br/>
251251
<code>map[string]string</code>
252252
</td>
253253
<td>
254-
<p>AuditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
254+
<p>auditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
255255
MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with
256256
admission webhook name (e.g. imagepolicy.example.com/error=image-blacklisted). AuditAnnotations will be provided by
257257
the admission webhook to add additional context to the audit log for this request.</p>

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

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,26 @@ 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.34/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
74+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#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.34/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
81+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
8282
</td>
8383
<td>
8484
<p>Impersonated user information.</p>
8585
</td>
8686
</tr>
87+
<tr><td><code>authenticationMetadata</code><br/>
88+
<a href="#audit-k8s-io-v1-AuthenticationMetadata"><code>AuthenticationMetadata</code></a>
89+
</td>
90+
<td>
91+
<p>AuthenticationMetadata contains details about how the request was authenticated.</p>
92+
</td>
93+
</tr>
8794
<tr><td><code>sourceIPs</code><br/>
8895
<code>[]string</code>
8996
</td>
@@ -116,7 +123,7 @@ Does not apply for List-type requests, or non-resource requests.</p>
116123
</td>
117124
</tr>
118125
<tr><td><code>responseStatus</code><br/>
119-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#status-v1-meta"><code>meta/v1.Status</code></a>
126+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#status-v1-meta"><code>meta/v1.Status</code></a>
120127
</td>
121128
<td>
122129
<p>The response status, populated even when the ResponseObject is not a Status type.
@@ -144,14 +151,14 @@ at Response Level.</p>
144151
</td>
145152
</tr>
146153
<tr><td><code>requestReceivedTimestamp</code><br/>
147-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
154+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
148155
</td>
149156
<td>
150157
<p>Time the request reached the apiserver.</p>
151158
</td>
152159
</tr>
153160
<tr><td><code>stageTimestamp</code><br/>
154-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
161+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
155162
</td>
156163
<td>
157164
<p>Time the request reached current audit stage.</p>
@@ -188,7 +195,7 @@ should be short. Annotations are included in the Metadata level.</p>
188195

189196

190197
<tr><td><code>metadata</code><br/>
191-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
198+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
192199
</td>
193200
<td>
194201
<span class="text-muted">No description provided.</span></td>
@@ -223,7 +230,7 @@ categories are logged.</p>
223230

224231

225232
<tr><td><code>metadata</code><br/>
226-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
233+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
227234
</td>
228235
<td>
229236
<p>ObjectMeta is included for interoperability with API infrastructure.</p>
@@ -253,7 +260,7 @@ be specified per rule in which case the union of both are omitted.</p>
253260
<td>
254261
<p>OmitManagedFields indicates whether to omit the managed fields of the request
255262
and response bodies from being written to the API audit log.
256-
This is used as a global default - a value of 'true' will omit the managed fields,
263+
This is used as a global default - a value of 'true' will omit the managed fileds,
257264
otherwise the managed fields will be included in the API audit log.
258265
Note that this can also be specified per rule in which case the value specified
259266
in a rule will override the global default.</p>
@@ -278,7 +285,7 @@ in a rule will override the global default.</p>
278285

279286

280287
<tr><td><code>metadata</code><br/>
281-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
288+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
282289
</td>
283290
<td>
284291
<span class="text-muted">No description provided.</span></td>
@@ -292,6 +299,31 @@ in a rule will override the global default.</p>
292299
</tbody>
293300
</table>
294301

302+
## `AuthenticationMetadata` {#audit-k8s-io-v1-AuthenticationMetadata}
303+
304+
305+
**Appears in:**
306+
307+
- [Event](#audit-k8s-io-v1-Event)
308+
309+
310+
311+
<table class="table">
312+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
313+
<tbody>
314+
315+
316+
<tr><td><code>impersonationConstraint</code><br/>
317+
<code>string</code>
318+
</td>
319+
<td>
320+
<p>ImpersonationConstraint is the verb associated with the constrained impersonation mode that was used to authorize
321+
the ImpersonatedUser associated with this audit event. It is only set when constrained impersonation was used.</p>
322+
</td>
323+
</tr>
324+
</tbody>
325+
</table>
326+
295327
## `GroupResources` {#audit-k8s-io-v1-GroupResources}
296328

297329

@@ -527,7 +559,7 @@ An empty list means no restrictions will apply.</p>
527559
and response bodies from being written to the API audit log.</p>
528560
<ul>
529561
<li>a value of 'true' will drop the managed fields from the API audit log</li>
530-
<li>a value of 'false' indicates that the managed fields should be included
562+
<li>a value of 'false' indicates that the managed fileds should be included
531563
in the API audit log
532564
Note that the value, if specified, in this rule will override the global default
533565
If a value is not specified then the global default specified in

‎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.34/#time-v1-meta"><code>meta/v1.Time</code></a>
208+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#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.34/#time-v1-meta"><code>meta/v1.Time</code></a>
208+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#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.34/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
31+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
3232
</td>
3333
<td>
3434
<p>Standard object's metadata.

0 commit comments

Comments
 (0)