Skip to content

Commit 6670c3c

Browse files
committed
Manually tune kubelet configuration reference
There are some format problems in the generated reference. These problems aren't easy to solve if not fixing the format of the upstream source code comments. This PR fixes them manually.
1 parent 6c954c2 commit 6670c3c

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ to provide credentials. Images are expected to contain the registry domain
8181
and URL path.</p>
8282
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
8383
Globs can be used in the domain, but not in the port or the path. Globs are supported
84-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
85-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
86-
a single subdomain segment, so *.io does not match *.k8s.io.</p>
84+
as subdomains like '&#42;.k8s.io' or 'k8s.&#42;.io', and top-level-domains such as 'k8s.&#42;'.
85+
Matching partial subdomains like 'app&#42;.k8s.io' is also supported. Each glob can only match
86+
a single subdomain segment, so &#42;.io does not match &#42;.k8s.io.</p>
8787
<p>A match exists between an image and a matchImage when all of the below are true:</p>
8888
<ul>
8989
<li>Both contain the same number of domain parts and each part matches.</li>
@@ -93,9 +93,9 @@ a single subdomain segment, so *.io does not match *.k8s.io.</p>
9393
<p>Example values of matchImages:</p>
9494
<ul>
9595
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
96-
<li>*.azurecr.io</li>
96+
<li>&#42;.azurecr.io</li>
9797
<li>gcr.io</li>
98-
<li><em>.</em>.registry.io</li>
98+
<li>&#42;.registry.io</li>
9999
<li>registry.io:8080/path</li>
100100
</ul>
101101
</td>
@@ -169,4 +169,4 @@ credential plugin.</p>
169169
</tr>
170170
</tbody>
171171
</table>
172-
172+

content/en/docs/reference/config-api/kubelet-config.v1beta1.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -214,13 +214,15 @@ Default: false</p>
214214
<a href="#kubelet-config-k8s-io-v1beta1-KubeletAuthentication"><code>KubeletAuthentication</code></a>
215215
</td>
216216
<td>
217-
<p>authentication specifies how requests to the Kubelet's server are authenticated.
218-
Defaults:
217+
<p>authentication specifies how requests to the Kubelet's server are authenticated.</p>
218+
<p>Defaults:</p>
219+
<p><code><pre>
219220
anonymous:
220-
enabled: false
221+
enabled: false
221222
webhook:
222-
enabled: true
223-
cacheTTL: &quot;2m&quot;</p>
223+
enabled: true
224+
cacheTTL: &quot;2m&quot;
225+
</pre></code></p>
224226
</td>
225227
</tr>
226228
<tr><td><code>authorization</code><br/>
@@ -483,7 +485,7 @@ Default: &quot;cgroupfs&quot;</p>
483485
<td>
484486
<p>cpuManagerPolicy is the name of the policy to use.
485487
Requires the CPUManager feature gate to be enabled.
486-
Default: &quot;None&quot;</p>
488+
Default: &quot;none&quot;</p>
487489
</td>
488490
</tr>
489491
<tr><td><code>cpuManagerPolicyOptions</code><br/>
@@ -501,7 +503,6 @@ Default: nil</p>
501503
</td>
502504
<td>
503505
<p>cpuManagerReconcilePeriod is the reconciliation period for the CPU Manager.
504-
Requires the CPUManager feature gate to be enabled.
505506
Default: &quot;10s&quot;</p>
506507
</td>
507508
</tr>
@@ -997,9 +998,9 @@ Default: [&quot;pods&quot;]</p>
997998
<code>[]string</code>
998999
</td>
9991000
<td>
1000-
<p>A comma separated whitelist of unsafe sysctls or sysctl patterns (ending in <code>*</code>).
1001-
Unsafe sysctl groups are <code>kernel.shm*</code>, <code>kernel.msg*</code>, <code>kernel.sem</code>, <code>fs.mqueue.*</code>,
1002-
and <code>net.*</code>. For example: &quot;<code>kernel.msg*,net.ipv4.route.min_pmtu</code>&quot;
1001+
<p>A comma separated whitelist of unsafe sysctls or sysctl patterns (ending in <code>&#42;</code>).
1002+
Unsafe sysctl groups are <code>kernel.shm&#42;</code>, <code>kernel.msg&#42;</code>, <code>kernel.sem</code>, <code>fs.mqueue.&#42;</code>,
1003+
and <code>net.&#42;</code>. For example: &quot;<code>kernel.msg&#42;,net.ipv4.route.min_pmtu</code>&quot;
10031004
Default: []</p>
10041005
</td>
10051006
</tr>
@@ -1302,9 +1303,9 @@ to provide credentials. Images are expected to contain the registry domain
13021303
and URL path.</p>
13031304
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
13041305
Globs can be used in the domain, but not in the port or the path. Globs are supported
1305-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
1306-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
1307-
a single subdomain segment, so *.io does not match *.k8s.io.</p>
1306+
as subdomains like '&#42;.k8s.io' or 'k8s.&#42;.io', and top-level-domains such as 'k8s.&#42;'.
1307+
Matching partial subdomains like 'app&#42;.k8s.io' is also supported. Each glob can only match
1308+
a single subdomain segment, so &#42;.io does not match &#42;.k8s.io.</p>
13081309
<p>A match exists between an image and a matchImage when all of the below are true:</p>
13091310
<ul>
13101311
<li>Both contain the same number of domain parts and each part matches.</li>
@@ -1314,9 +1315,9 @@ a single subdomain segment, so *.io does not match *.k8s.io.</p>
13141315
<p>Example values of matchImages:</p>
13151316
<ul>
13161317
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
1317-
<li>*.azurecr.io</li>
1318+
<li>&#42;.azurecr.io</li>
13181319
<li>gcr.io</li>
1319-
<li><em>.</em>.registry.io</li>
1320+
<li>&#42;.registry.io</li>
13201321
<li>registry.io:8080/path</li>
13211322
</ul>
13221323
</td>

0 commit comments

Comments
 (0)