Skip to content

Commit 5dfea11

Browse files
committed
Update config API reference
This PR refreshes the config API references using the latest generator which had some nits fixed.
1 parent 3721610 commit 5dfea11

12 files changed

+3543
-4057
lines changed

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

Lines changed: 146 additions & 219 deletions
Large diffs are not rendered by default.

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

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ content_type: tool-reference
44
package: apiserver.config.k8s.io/v1
55
auto_generated: true
66
---
7-
Package v1 is the v1 version of the API.
7+
<p>Package v1 is the v1 version of the API.</p>
8+
89

910
## Resource Types
1011

@@ -17,75 +18,67 @@ Package v1 is the v1 version of the API.
1718

1819

1920

21+
<p>AdmissionConfiguration provides versioned configuration for admission controllers.</p>
2022

2123

22-
AdmissionConfiguration provides versioned configuration for admission controllers.
23-
2424
<table class="table">
2525
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
2626
<tbody>
2727

2828
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr>
2929
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
3030

31-
32-
3331

3432
<tr><td><code>plugins</code><br/>
3533
<a href="#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
3634
</td>
3735
<td>
38-
Plugins allows specifying a configuration per admission control plugin.</td>
36+
<p>Plugins allows specifying a configuration per admission control plugin.</p>
37+
</td>
3938
</tr>
40-
41-
4239
</tbody>
4340
</table>
4441

4542
## `AdmissionPluginConfiguration` {#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration}
4643

4744

48-
49-
5045
**Appears in:**
46+
5147
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
5248

5349

54-
AdmissionPluginConfiguration provides the configuration for a single plug-in.
50+
<p>AdmissionPluginConfiguration provides the configuration for a single plug-in.</p>
51+
5552

5653
<table class="table">
5754
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
5855
<tbody>
5956

60-
6157

6258
<tr><td><code>name</code> <B>[Required]</B><br/>
6359
<code>string</code>
6460
</td>
6561
<td>
66-
Name is the name of the admission controller.
67-
It must match the registered admission plugin name.</td>
62+
<p>Name is the name of the admission controller.
63+
It must match the registered admission plugin name.</p>
64+
</td>
6865
</tr>
69-
70-
7166
<tr><td><code>path</code><br/>
7267
<code>string</code>
7368
</td>
7469
<td>
75-
Path is the path to a configuration file that contains the plugin's
76-
configuration</td>
70+
<p>Path is the path to a configuration file that contains the plugin's
71+
configuration</p>
72+
</td>
7773
</tr>
78-
79-
8074
<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>
75+
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a>
8276
</td>
8377
<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>
78+
<p>Configuration is an embedded configuration object to be used as the plugin's
79+
configuration. If present, it will be used instead of the path to the configuration file.</p>
80+
</td>
8681
</tr>
87-
88-
8982
</tbody>
9083
</table>
9184

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

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ content_type: tool-reference
44
package: apiserver.config.k8s.io/v1
55
auto_generated: true
66
---
7-
Package v1 is the v1 version of the API.
7+
<p>Package v1 is the v1 version of the API.</p>
8+
89

910
## Resource Types
1011

@@ -17,28 +18,24 @@ Package v1 is the v1 version of the API.
1718

1819

1920

21+
<p>WebhookAdmission provides configuration for the webhook admission controller.</p>
2022

2123

22-
WebhookAdmission provides configuration for the webhook admission controller.
23-
2424
<table class="table">
2525
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
2626
<tbody>
2727

2828
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr>
2929
<tr><td><code>kind</code><br/>string</td><td><code>WebhookAdmission</code></td></tr>
3030

31-
32-
3331

3432
<tr><td><code>kubeConfigFile</code> <B>[Required]</B><br/>
3533
<code>string</code>
3634
</td>
3735
<td>
38-
KubeConfigFile is the path to the kubeconfig file.</td>
36+
<p>KubeConfigFile is the path to the kubeconfig file.</p>
37+
</td>
3938
</tr>
40-
41-
4239
</tbody>
4340
</table>
4441

0 commit comments

Comments
 (0)