Skip to content

Commit bcc29e3

Browse files
authored
Merge pull request #42577 from tengqm/configapi-1.28
Revise config API docs for v1.28
2 parents 5757935 + 79a8627 commit bcc29e3

19 files changed

+2240
-1935
lines changed

content/en/docs/reference/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ operator to use or manage a cluster.
8787
* [kubelet credential providers (v1alpha1)](/docs/reference/config-api/kubelet-credentialprovider.v1alpha1/),
8888
[kubelet credential providers (v1beta1)](/docs/reference/config-api/kubelet-credentialprovider.v1beta1/) and
8989
[kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
90-
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/),
9190
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
9291
[kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/)
9392
* [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
@@ -101,6 +100,7 @@ operator to use or manage a cluster.
101100
## Config API for kubeadm
102101

103102
* [v1beta3](/docs/reference/config-api/kubeadm-config.v1beta3/)
103+
* [v1beta4](/docs/reference/config-api/kubeadm-config.v1beta4/)
104104

105105
## Design Docs
106106

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

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

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

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ For non-resource requests, this is the lower-cased HTTP method.</p>
7272
</td>
7373
</tr>
7474
<tr><td><code>user</code> <B>[Required]</B><br/>
75-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
75+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
7676
</td>
7777
<td>
7878
<p>Authenticated user information.</p>
7979
</td>
8080
</tr>
8181
<tr><td><code>impersonatedUser</code><br/>
82-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
82+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
8383
</td>
8484
<td>
8585
<p>Impersonated user information.</p>
@@ -117,7 +117,7 @@ Does not apply for List-type requests, or non-resource requests.</p>
117117
</td>
118118
</tr>
119119
<tr><td><code>responseStatus</code><br/>
120-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#status-v1-meta"><code>meta/v1.Status</code></a>
120+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#status-v1-meta"><code>meta/v1.Status</code></a>
121121
</td>
122122
<td>
123123
<p>The response status, populated even when the ResponseObject is not a Status type.
@@ -145,14 +145,14 @@ at Response Level.</p>
145145
</td>
146146
</tr>
147147
<tr><td><code>requestReceivedTimestamp</code><br/>
148-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
148+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
149149
</td>
150150
<td>
151151
<p>Time the request reached the apiserver.</p>
152152
</td>
153153
</tr>
154154
<tr><td><code>stageTimestamp</code><br/>
155-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
155+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
156156
</td>
157157
<td>
158158
<p>Time the request reached current audit stage.</p>
@@ -189,7 +189,7 @@ should be short. Annotations are included in the Metadata level.</p>
189189

190190

191191
<tr><td><code>metadata</code><br/>
192-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
192+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
193193
</td>
194194
<td>
195195
<span class="text-muted">No description provided.</span></td>
@@ -224,7 +224,7 @@ categories are logged.</p>
224224

225225

226226
<tr><td><code>metadata</code><br/>
227-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
227+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
228228
</td>
229229
<td>
230230
<p>ObjectMeta is included for interoperability with API infrastructure.</p>
@@ -279,7 +279,7 @@ in a rule will override the global default.</p>
279279

280280

281281
<tr><td><code>metadata</code><br/>
282-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
282+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
283283
</td>
284284
<td>
285285
<span class="text-muted">No description provided.</span></td>
@@ -322,14 +322,12 @@ The empty string represents the core API group.</p>
322322
</td>
323323
<td>
324324
<p>Resources is a list of resources this rule applies to.</p>
325-
<p>For example:</p>
326-
<ul>
327-
<li><code>pods</code> matches pods.</li>
328-
<li><code>pods/log</code> matches the log subresource of pods.</li>
329-
<li><code>&ast;<code> matches all resources and their subresources.</li>
330-
<li><code>pods/&ast;</code> matches all subresources of pods.</li>
331-
<li><code>&ast;/scale</code> matches all scale subresources.</li>
332-
</ul>
325+
<p>For example:
326+
'pods' matches pods.
327+
'pods/log' matches the log subresource of pods.
328+
'<em>' matches all resources and their subresources.
329+
'pods/</em>' matches all subresources of pods.
330+
'*/scale' matches all scale subresources.</p>
333331
<p>If wildcard is present, the validation rule will ensure resources do not
334332
overlap with each other.</p>
335333
<p>An empty list implies all resources and subresources in this API groups apply.</p>
@@ -503,12 +501,10 @@ An empty list implies every namespace.</p>
503501
</td>
504502
<td>
505503
<p>NonResourceURLs is a set of URL paths that should be audited.
506-
<code>&ast;<code>s are allowed, but only as the full, final step in the path.
507-
Examples:</p>
508-
<ul>
509-
<li>&quot;/metrics&quot; - Log requests for apiserver metrics</li>
510-
<li>&quot;/healthz&ast;&quot; - Log all health checks</li>
511-
</ul>
504+
<em>s are allowed, but only as the full, final step in the path.
505+
Examples:
506+
&quot;/metrics&quot; - Log requests for apiserver metrics
507+
&quot;/healthz</em>&quot; - Log all health checks</p>
512508
</td>
513509
</tr>
514510
<tr><td><code>omitStages</code><br/>
@@ -556,4 +552,4 @@ Policy.OmitManagedFields will stand.</li>
556552

557553

558554

559-
555+

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ auto_generated: true
2020

2121
<p>EncryptionConfiguration stores the complete configuration for encryption providers.
2222
It also allows the use of wildcards to specify the resources that should be encrypted.
23-
Use <code>&ast;.&lt;group&gt;</code> to encrypt all resources within a group or <code>&ast;.&ast;</code> to encrypt all resources.
24-
<code>&ast;.</code> can be used to encrypt all resource in the core group. <code>&ast;.&ast;</code> will encrypt all
23+
Use '<em>.<!-- raw HTML omitted -->' to encrypt all resources within a group or '</em>.<em>' to encrypt all resources.
24+
'</em>.' can be used to encrypt all resource in the core group. '<em>.</em>' will encrypt all
2525
resources, even custom resources that are added after API server start.
2626
Use of wildcards that overlap within the same resource list or across multiple
2727
entries are not allowed since part of the configuration would be ineffective.
@@ -282,10 +282,10 @@ Set to a negative value to disable caching. This field is only allowed for KMS v
282282
</td>
283283
<td>
284284
<p>resources is a list of kubernetes resources which have to be encrypted. The resource names are derived from <code>resource</code> or <code>resource.group</code> of the group/version/resource.
285-
eg: <code>pandas.awesome.bears.example</code> is a custom resource with 'group': <code>awesome.bears.example</code>, 'resource': <code>pandas</code>.
286-
Use <code>&ast;.&ast;</code> to encrypt all resources and <code>&ast;.&lt;group&gt;</code>' to encrypt all resources in a specific group.
287-
eg: <code>&ast;.awesome.bears.example</code> will encrypt all resources in the group <code>awesome.bears.example</code>.
288-
eg: <code>&ast;.</code> will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
285+
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
286+
Use '<em>.</em>' to encrypt all resources and '<em>.<!-- raw HTML omitted -->' to encrypt all resources in a specific group.
287+
eg: '</em>.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
288+
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
289289
</td>
290290
</tr>
291291
<tr><td><code>providers</code> <B>[Required]</B><br/>
@@ -325,4 +325,4 @@ Each key has to be 32 bytes long.</p>
325325
</tr>
326326
</tbody>
327327
</table>
328-
328+

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

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

207207

208208
<tr><td><code>expirationTimestamp</code><br/>
209-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta"><code>meta/v1.Time</code></a>
209+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
210210
</td>
211211
<td>
212212
<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
@@ -206,7 +206,7 @@ itself should at least be protected via file permissions.</p>
206206

207207

208208
<tr><td><code>expirationTimestamp</code><br/>
209-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta"><code>meta/v1.Time</code></a>
209+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
210210
</td>
211211
<td>
212212
<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
@@ -29,7 +29,7 @@ auto_generated: true
2929

3030

3131
<tr><td><code>metadata</code><br/>
32-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
32+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
3333
</td>
3434
<td>
3535
<p>Standard object's metadata.

0 commit comments

Comments
 (0)