Skip to content

Commit 30d2c82

Browse files
committed
Manually fix nits in the generated reference.
1 parent 6fa7b80 commit 30d2c82

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ auto_generated: true
4545

4646
<p>EncryptionConfiguration stores the complete configuration for encryption providers.
4747
It also allows the use of wildcards to specify the resources that should be encrypted.
48-
Use '<em>.<!-- raw HTML omitted -->' to encrypt all resources within a group or '</em>.<em>' to encrypt all resources.
49-
'</em>.' can be used to encrypt all resource in the core group. '<em>.</em>' will encrypt all
48+
Use '&ast;.&lt;group&gt;' to encrypt all resources within a group or '&ast;.&ast;' to encrypt all resources.
49+
'&ast;.' can be used to encrypt all resource in the core group. '&ast;.&ast;' will encrypt all
5050
resources, even custom resources that are added after API server start.
5151
Use of wildcards that overlap within the same resource list or across multiple
5252
entries are not allowed since part of the configuration would be ineffective.
@@ -351,9 +351,9 @@ Set to a negative value to disable caching. This field is only allowed for KMS v
351351
<td>
352352
<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.
353353
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
354-
Use '<em>.</em>' to encrypt all resources and '<em>.<!-- raw HTML omitted -->' to encrypt all resources in a specific group.
355-
eg: '</em>.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
356-
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
354+
Use '&ast;.&ast;' to encrypt all resources and '&ast;.&lt;group&gt;' to encrypt all resources in a specific group.
355+
eg: '&ast;.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
356+
eg: '&ast;.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
357357
</td>
358358
</tr>
359359
<tr><td><code>providers</code> <B>[Required]</B><br/>
@@ -393,4 +393,4 @@ Each key has to be 32 bytes long.</p>
393393
</tr>
394394
</tbody>
395395
</table>
396-
396+

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ JWT authenticator will attempt to cryptographically validate the token.</p>
119119
&quot;iss&quot;: &quot;https://issuer.example.com&quot;,
120120
&quot;aud&quot;: [&quot;audience&quot;],
121121
&quot;exp&quot;: 1234567890,
122-
&quot;<!-- raw HTML omitted -->&quot;: &quot;username&quot;
122+
&quot;&lt;username claim&gt;&quot;: &quot;username&quot;
123123
}</p>
124124
</td>
125125
</tr>
@@ -331,7 +331,7 @@ The claim's value must be a singular string.
331331
Same as the --oidc-username-claim and --oidc-username-prefix flags.
332332
If username.expression is set, the expression must produce a string value.
333333
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
334-
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
334+
username.expression or extra[&ast;].valueExpression or claimValidationRules[&ast;].expression.
335335
An example claim validation rule expression that matches the validation automatically
336336
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.</p>
337337
<p>In the flag based approach, the --oidc-username-claim and --oidc-username-prefix are optional. If --oidc-username-claim is not set,
@@ -341,8 +341,8 @@ For prefix:
341341
(1) --oidc-username-prefix=&quot;-&quot;, no prefix was added to the username. For the same behavior using authentication config,
342342
set username.prefix=&quot;&quot;
343343
(2) --oidc-username-prefix=&quot;&quot; and --oidc-username-claim != &quot;email&quot;, prefix was &quot;&lt;value of --oidc-issuer-url&gt;#&quot;. For the same
344-
behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->#&quot;
345-
(3) --oidc-username-prefix=&quot;<!-- raw HTML omitted -->&quot;. For the same behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->&quot;</p>
344+
behavior using authentication config, set username.prefix=&quot;&lt;value of issuer.url&gt;#&quot;
345+
(3) --oidc-username-prefix=&quot;&lt;value&gt;&quot;. For the same behavior using authentication config, set username.prefix=&quot;&lt;value&gt;&quot;</p>
346346
</td>
347347
</tr>
348348
<tr><td><code>groups</code><br/>
@@ -1202,4 +1202,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
12021202
</tr>
12031203
</tbody>
12041204
</table>
1205-
1205+

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ JWT authenticator will attempt to cryptographically validate the token.</p>
9595
&quot;iss&quot;: &quot;https://issuer.example.com&quot;,
9696
&quot;aud&quot;: [&quot;audience&quot;],
9797
&quot;exp&quot;: 1234567890,
98-
&quot;<!-- raw HTML omitted -->&quot;: &quot;username&quot;
98+
&quot;&lt;username claim&gt;&quot;: &quot;username&quot;
9999
}</p>
100100
</td>
101101
</tr>
@@ -264,7 +264,7 @@ The claim's value must be a singular string.
264264
Same as the --oidc-username-claim and --oidc-username-prefix flags.
265265
If username.expression is set, the expression must produce a string value.
266266
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
267-
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
267+
username.expression or extra[&ast;].valueExpression or claimValidationRules[&ast;].expression.
268268
An example claim validation rule expression that matches the validation automatically
269269
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.</p>
270270
<p>In the flag based approach, the --oidc-username-claim and --oidc-username-prefix are optional. If --oidc-username-claim is not set,
@@ -274,8 +274,8 @@ For prefix:
274274
(1) --oidc-username-prefix=&quot;-&quot;, no prefix was added to the username. For the same behavior using authentication config,
275275
set username.prefix=&quot;&quot;
276276
(2) --oidc-username-prefix=&quot;&quot; and --oidc-username-claim != &quot;email&quot;, prefix was &quot;&lt;value of --oidc-issuer-url&gt;#&quot;. For the same
277-
behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->#&quot;
278-
(3) --oidc-username-prefix=&quot;<!-- raw HTML omitted -->&quot;. For the same behavior using authentication config, set username.prefix=&quot;<!-- raw HTML omitted -->&quot;</p>
277+
behavior using authentication config, set username.prefix=&quot;&lt;value of issuer.url&gt;#&quot;
278+
(3) --oidc-username-prefix=&quot;&lt;value&gt;&quot;. For the same behavior using authentication config, set username.prefix=&quot;&lt;value&gt;&quot;</p>
279279
</td>
280280
</tr>
281281
<tr><td><code>groups</code><br/>
@@ -1135,4 +1135,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
11351135
</tr>
11361136
</tbody>
11371137
</table>
1138-
1138+

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

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

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1507,7 +1507,7 @@ Also, avoid specifying:</p>
15071507
<li>Duplicates, the same NUMA node, and memory type, but with a different value.</li>
15081508
<li>zero limits for any memory type.</li>
15091509
<li>NUMAs nodes IDs that do not exist under the machine.</li>
1510-
<li>memory types except for memory and hugepages-<!-- raw HTML omitted --></li>
1510+
<li>memory types except for memory and hugepages-&lt;size&gt;</li>
15111511
</ol>
15121512
<p>Default: nil</p>
15131513
</td>
@@ -1675,9 +1675,9 @@ to provide credentials. Images are expected to contain the registry domain
16751675
and URL path.</p>
16761676
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
16771677
Globs can be used in the domain, but not in the port or the path. Globs are supported
1678-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
1679-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
1680-
a single subdomain segment, so *.io does not match *.k8s.io.</p>
1678+
as subdomains like '&ast;.k8s.io' or 'k8s.&ast;.io', and top-level-domains such as 'k8s.&ast;'.
1679+
Matching partial subdomains like 'app&ast;.k8s.io' is also supported. Each glob can only match
1680+
a single subdomain segment, so '&ast;.io' does not match '&ast;.k8s.io'.</p>
16811681
<p>A match exists between an image and a matchImage when all of the below are true:</p>
16821682
<ul>
16831683
<li>Both contain the same number of domain parts and each part matches.</li>
@@ -1687,9 +1687,9 @@ a single subdomain segment, so *.io does not match *.k8s.io.</p>
16871687
<p>Example values of matchImages:</p>
16881688
<ul>
16891689
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
1690-
<li>*.azurecr.io</li>
1690+
<li>&ast;.azurecr.io</li>
16911691
<li>gcr.io</li>
1692-
<li><em>.</em>.registry.io</li>
1692+
<li>&ast;.&ast;.registry.io</li>
16931693
<li>registry.io:8080/path</li>
16941694
</ul>
16951695
</td>
@@ -2071,4 +2071,4 @@ managers (secret, configmap) are discovering object changes.</p>
20712071
</tr>
20722072
</tbody>
20732073
</table>
2074-
2074+

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ should be valid for all images that match against this key. A plugin should set
8888
this field to null if no valid credentials can be returned for the requested image.</p>
8989
<p>Each key in the map is a pattern which can optionally contain a port and a path.
9090
Globs can be used in the domain, but not in the port or the path. Globs are supported
91-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
92-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
93-
a single subdomain segment, so *.io does not match *.k8s.io.</p>
91+
as subdomains like '&ast;.k8s.io' or 'k8s.&ast;.io', and top-level-domains such as 'k8s.&ast;'.
92+
Matching partial subdomains like 'app&ast;.k8s.io' is also supported. Each glob can only match
93+
a single subdomain segment, so '&ast;.io' does not match '&ast;.k8s.io'.</p>
9494
<p>The kubelet will match images against the key when all of the below are true:</p>
9595
<ul>
9696
<li>Both contain the same number of domain parts and each part matches.</li>
@@ -107,9 +107,9 @@ stopping after the first successfully authenticated pull.</p>
107107
<p>Example keys:</p>
108108
<ul>
109109
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
110-
<li>*.azurecr.io</li>
110+
<li>&ast;.azurecr.io</li>
111111
<li>gcr.io</li>
112-
<li><em>.</em>.registry.io</li>
112+
<li>&ast;.&ast;.registry.io</li>
113113
<li>registry.io:8080/path</li>
114114
</ul>
115115
</td>
@@ -165,4 +165,4 @@ An empty password is valid.</p>
165165

166166

167167

168-
168+

0 commit comments

Comments
 (0)