Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 98329b3

Browse filesBrowse files
committed
Fix config API reference
Some of the config API references contain strings that are not properly escaped. These could have been fixed in the upstream source code in the future, because the generator cannot properly handle them.
1 parent 894a841 commit 98329b3
Copy full SHA for 98329b3

6 files changed

+25
-25
lines changed

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/apiserver-config.v1.md
+5-5
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Must be at least one.</p>
7272

7373
<p>EncryptionConfiguration stores the complete configuration for encryption providers.
7474
It also allows the use of wildcards to specify the resources that should be encrypted.
75-
Use '<em>.<!-- raw HTML omitted -->' to encrypt all resources within a group or '</em>.<em>' to encrypt all resources.
76-
'</em>.' can be used to encrypt all resource in the core group. '<em>.</em>' will encrypt all
75+
Use '&ast;.&lt;group&gt;' to encrypt all resources within a group or '&ast;.&ast;' to encrypt all resources.
76+
'&ast;.' can be used to encrypt all resource in the core group. '&ast;.&ast;' will encrypt all
7777
resources, even custom resources that are added after API server start.
7878
Use of wildcards that overlap within the same resource list or across multiple
7979
entries are not allowed since part of the configuration would be ineffective.
@@ -426,8 +426,8 @@ Set to a negative value to disable caching. This field is only allowed for KMS v
426426
<td>
427427
<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.
428428
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
429-
Use '<em>.</em>' to encrypt all resources and '<em>.<!-- raw HTML omitted -->' to encrypt all resources in a specific group.
430-
eg: '</em>.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
429+
Use '&ast;.&ast;' to encrypt all resources and '&ast;.&lt;group&gt;' to encrypt all resources in a specific group.
430+
eg: '&ast;.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
431431
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
432432
</td>
433433
</tr>
@@ -654,4 +654,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
654654
</tr>
655655
</tbody>
656656
</table>
657-
657+

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/apiserver-config.v1alpha1.md
+2-2
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ The claim's value must be a singular string.
398398
Same as the --oidc-username-claim and --oidc-username-prefix flags.
399399
If username.expression is set, the expression must produce a string value.
400400
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
401-
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
401+
username.expression or extra[&ast;].valueExpression or claimValidationRules[<&ast;>].expression.
402402
An example claim validation rule expression that matches the validation automatically
403403
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true) == true'. By explicitly comparing
404404
the value to true, we let type-checking see the result will be a boolean, and to make sure a non-boolean email_verified
@@ -1279,4 +1279,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
12791279
</tr>
12801280
</tbody>
12811281
</table>
1282-
1282+

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/apiserver-config.v1beta1.md
+2-2
Original file line numberDiff line numberDiff line change
@@ -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) == true'. By explicitly comparing
337337
the value to true, we let type-checking see the result will be a boolean, and to make sure a non-boolean email_verified
@@ -1212,4 +1212,4 @@ the contents would be converted to the v1 version before evaluating the CEL expr
12121212
</tr>
12131213
</tbody>
12141214
</table>
1215-
1215+

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/kubelet-config.v1.md
+4-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ 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>'.
84+
as subdomains like '&ast;.k8s.io' or 'k8s.&ast;.io', and top-level-domains such as 'k8s.&ast;'.
8585
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
8686
a single subdomain segment, so *.io does not match *.k8s.io.</p>
8787
<p>A match exists between an image and a matchImage when all of the below are true:</p>
@@ -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>&ast;.azurecr.io</li>
9797
<li>gcr.io</li>
98-
<li><em>.</em>.registry.io</li>
98+
<li>&ast;.&ast;.registry.io</li>
9999
<li>registry.io:8080/path</li>
100100
</ul>
101101
</td>
@@ -257,4 +257,4 @@ additional information required to fetch credentials.</p>
257257
</tr>
258258
</tbody>
259259
</table>
260-
260+

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/kubelet-config.v1beta1.md
+7-7
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ can be used without reverifying pull credentials</li>
639639
<p>preloadedImagesVerificationAllowlist specifies a list of images that are
640640
exempted from credential reverification for the &quot;NeverVerifyAllowlistedImages&quot;
641641
<code>imagePullCredentialsVerificationPolicy</code>.
642-
The list accepts a full path segment wildcard suffix &quot;/*&quot;.
642+
The list accepts a full path segment wildcard suffix &quot;/&ast;&quot;.
643643
Only use image specs without an image tag or digest.</p>
644644
</td>
645645
</tr>
@@ -1795,9 +1795,9 @@ to provide credentials. Images are expected to contain the registry domain
17951795
and URL path.</p>
17961796
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
17971797
Globs can be used in the domain, but not in the port or the path. Globs are supported
1798-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
1799-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
1800-
a single subdomain segment, so *.io does not match *.k8s.io.</p>
1798+
as subdomains like '&ast;.k8s.io' or 'k8s.&ast;.io', and top-level-domains such as 'k8s.&ast;'.
1799+
Matching partial subdomains like 'app&ast;.k8s.io' is also supported. Each glob can only match
1800+
a single subdomain segment, so '&ast;.io' does not match '&ast;.k8s.io'.</p>
18011801
<p>A match exists between an image and a matchImage when all of the below are true:</p>
18021802
<ul>
18031803
<li>Both contain the same number of domain parts and each part matches.</li>
@@ -1807,9 +1807,9 @@ a single subdomain segment, so *.io does not match *.k8s.io.</p>
18071807
<p>Example values of matchImages:</p>
18081808
<ul>
18091809
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
1810-
<li>*.azurecr.io</li>
1810+
<li>&ast;.azurecr.io</li>
18111811
<li>gcr.io</li>
1812-
<li><em>.</em>.registry.io</li>
1812+
<li>&ast;.&ast;.registry.io</li>
18131813
<li>registry.io:8080/path</li>
18141814
</ul>
18151815
</td>
@@ -2236,4 +2236,4 @@ On non-linux such as windows, only null / absent is allowed.</p>
22362236
</tr>
22372237
</tbody>
22382238
</table>
2239-
2239+

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

Copy file name to clipboardExpand all lines: content/en/docs/reference/config-api/kubelet-credentialprovider.v1.md
+5-5
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ should be valid for all images that match against this key. A plugin should set
108108
this field to null if no valid credentials can be returned for the requested image.</p>
109109
<p>Each key in the map is a pattern which can optionally contain a port and a path.
110110
Globs can be used in the domain, but not in the port or the path. Globs are supported
111-
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
112-
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
111+
as subdomains like '&ast;.k8s.io' or 'k8s.&ast;.io', and top-level-domains such as 'k8s.&ast;'.
112+
Matching partial subdomains like 'app&ast;.k8s.io' is also supported. Each glob can only match
113113
a single subdomain segment, so *.io does not match *.k8s.io.</p>
114114
<p>The kubelet will match images against the key when all of the below are true:</p>
115115
<ul>
@@ -127,9 +127,9 @@ stopping after the first successfully authenticated pull.</p>
127127
<p>Example keys:</p>
128128
<ul>
129129
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
130-
<li>*.azurecr.io</li>
130+
<li>&ast;.azurecr.io</li>
131131
<li>gcr.io</li>
132-
<li><em>.</em>.registry.io</li>
132+
<li>&ast;.&ast;.registry.io</li>
133133
<li>registry.io:8080/path</li>
134134
</ul>
135135
</td>
@@ -185,4 +185,4 @@ An empty password is valid.</p>
185185

186186

187187

188-
188+

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.