@@ -10,10 +10,12 @@ package: apiserver.k8s.io/v1alpha1
10
10
auto_generated: true
11
11
-->
12
12
13
+ <p >
13
14
<!--
14
15
Package v1alpha1 is the v1alpha1 version of the API.
15
16
-->
16
- <p >包 v1alpha1 包含 API 的 v1alpha1 版本。</p >
17
+ 包 v1alpha1 包含 API 的 v1alpha1 版本。
18
+ </p >
17
19
18
20
<!--
19
21
## Resource Types
@@ -125,11 +127,11 @@ AuthenticationConfiguration 为身份认证提供版本化的配置。
125
127
<table class =" table " >
126
128
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
127
129
<tbody >
128
-
130
+
129
131
<tr ><td ><code >apiVersion</code ><br />string</td ><td ><code >apiserver.k8s.io/v1alpha1</code ></td ></tr >
130
132
<tr ><td ><code >kind</code ><br />string</td ><td ><code >AuthenticationConfiguration</code ></td ></tr >
131
-
132
-
133
+
134
+
133
135
<tr ><td ><code >jwt</code > <B ><!-- [Required]--> [必需]</B ><br />
134
136
<a href =" #apiserver-k8s-io-v1beta1-JWTAuthenticator " ><code >[ ] JWTAuthenticator</code ></a >
135
137
</td >
@@ -191,7 +193,7 @@ The minimum valid JWT payload must contain the following claims:
191
193
<table class =" table " >
192
194
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
193
195
<tbody >
194
-
196
+
195
197
<tr ><td ><code >apiVersion</code ><br />string</td ><td ><code >apiserver.k8s.io/v1alpha1</code ></td ></tr >
196
198
<tr ><td ><code >kind</code ><br />string</td ><td ><code >AuthorizationConfiguration</code ></td ></tr >
197
199
@@ -397,8 +399,8 @@ AnonymousAuthConfig 为匿名身份认证器提供配置信息。</p>
397
399
<table class =" table " >
398
400
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
399
401
<tbody >
400
-
401
-
402
+
403
+
402
404
<tr ><td ><code >enabled</code > <B ><!-- [Required]--> [必需]</B ><br />
403
405
<code >bool</code >
404
406
</td >
@@ -453,8 +455,8 @@ AudienceMatchPolicyType 是 issuer.audienceMatchPolicy 合法值的集合
453
455
<table class =" table " >
454
456
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
455
457
<tbody >
456
-
457
-
458
+
459
+
458
460
<tr ><td ><code >type</code > <B ><!-- [Required]--> [必需]</B ><br />
459
461
<code >string</code >
460
462
</td >
@@ -544,7 +546,9 @@ If username.expression is set, the expression must produce a string value.
544
546
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
545
547
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
546
548
An example claim validation rule expression that matches the validation automatically
547
- applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.
549
+ applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true) == true'. By explicitly comparing
550
+ the value to true, we let type-checking see the result will be a boolean, and to make sure a non-boolean email_verified
551
+ claim will be caught at runtime.<
548
552
-->
549
553
username 表示用户名属性的一个选项。
550
554
声明的值必须是单一字符串。
@@ -555,6 +559,8 @@ applied when username.claim is set to 'email' is 'claims.?email_verified.orValue
555
559
或 <code >claimValidationRules[ * ] .expression</code > 中使用 'claims.email_verified'。
556
560
这里有一个声明验证规则表达式的示例,当 username.claim 设置为 'email' 时与自动应用的验证所匹配:
557
561
'claims.?email_verified.orValue(true)'。
562
+ 通过显式地将值与 true 进行比较,我们可以看到类型检查的结果将是一个布尔值,
563
+ 并确保在运行时捕获到非布尔值的 email_verified 声明。
558
564
</p >
559
565
<p >
560
566
<!--
@@ -568,13 +574,13 @@ For prefix:
568
574
behavior using authentication config, set username.prefix="<value of issuer.url>#"
569
575
(3) --oidc-username-prefix="<value>". For the same behavior using authentication config, set username.prefix="<value>"
570
576
-->
571
- 在基于标志的方法中,--oidc-username-claim 和 --oidc-username-prefix
572
- 是可选的。如果未设置 --oidc-username-claim,默认值为 " ; sub" ; 。
577
+ 在基于标志的方法中,< code > --oidc-username-claim</ code > 和 < code > --oidc-username-prefix</ code >
578
+ 是可选的。如果未设置 < code > --oidc-username-claim</ code > ,默认值为 " ; sub" ; 。
573
579
对于身份认证配置,声明或前缀都没有默认值。声明和前缀必须显式设置。
574
- 对于声明,如果在传统标志方法中未设置 --oidc-username-claim,
580
+ 对于声明,如果在传统标志方法中未设置 < code > --oidc-username-claim</ code > ,
575
581
请在身份认证配置中配置 username.claim=" ; sub" ; 。
576
582
对于前缀:
577
- (1) --oidc-username-prefix="-", 未添加前缀到用户名。要实现相同的行为,请在身份认证配置中设置
583
+ (1) --oidc-username-prefix="-", 未添加前缀到用户名。要实现相同的行为,请在身份认证配置中设置
578
584
username.prefix=" ;" ;
579
585
(2) --oidc-username-prefix=" ;" ; 并且 --oidc-username-claim != " ; email" ; ,
580
586
前缀为 " ;< ; --oidc-issuer-url 的值> ; #" ; 。要实现相同的行为,请在身份认证配置中设置
@@ -598,8 +604,8 @@ If groups.expression is set, the expression must produce a string or string arra
598
604
-->
599
605
groups 表示 groups 属性的一个选项。
600
606
其中 claim 字段的值必须是字符串或字符串数组。
601
- 如果设置了 groups.claim,则必须指定 prefix 字段(可以是空字符串)。
602
- 如果设置了 groups.expression,则该表达式必须生成一个字符串或字符串数组值。
607
+ 如果设置了 < code > groups.claim</ code > ,则必须指定 prefix 字段(可以是空字符串)。
608
+ 如果设置了 < code > groups.expression</ code > ,则该表达式必须生成一个字符串或字符串数组值。
603
609
" ;" ; 、[ ] 和 null 值被视为不存在组映射。
604
610
</p >
605
611
</td >
@@ -616,7 +622,7 @@ If uid.expression is set, the expression must produce a string value.
616
622
-->
617
623
uid 表示 uid 属性的一个选项。
618
624
其中的 claim 字段必须是一个字符串。
619
- 如果设置了 uid.expression,则该表达式必须生成一个字符串值。
625
+ 如果设置了 < code > uid.expression</ code > ,则该表达式必须生成一个字符串值。
620
626
</p >
621
627
</td >
622
628
</tr >
@@ -654,7 +660,9 @@ This will result in:
654
660
- key: "foo"
655
661
valueExpression: "'bar'"
656
662
</pre >
657
- 这将导致一个额外的属性 - foo: [ " ; bar" ; ] <br />
663
+ 这将导致一个额外的属性 - foo: [ " ; bar" ; ]
664
+
665
+ <br />
658
666
659
667
硬编码 key,value 从声明的值复制
660
668
<pre >
@@ -708,8 +716,8 @@ ClaimOrExpression 为单个声明或表达式提供配置信息。
708
716
<table class =" table " >
709
717
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
710
718
<tbody >
711
-
712
-
719
+
720
+
713
721
<tr ><td ><code >claim</code ><br />
714
722
<code >string</code >
715
723
</td >
@@ -787,7 +795,7 @@ Only string claim keys are supported.
787
795
Mutually exclusive with expression and message.
788
796
-->
789
797
claim 是所需要的声明的名称。
790
- 与 --oidc-required-claim 标志相同。
798
+ 与 < code > --oidc-required-claim</ code > 标志相同。
791
799
仅支持用字符串声明键。
792
800
与 expression 和 message 互斥。
793
801
</p >
@@ -806,7 +814,7 @@ If claim is set and requiredValue is not set, the claim must be present with a v
806
814
Mutually exclusive with expression and message.
807
815
-->
808
816
requiredValue 是声明中必须包含的值。
809
- 与 --oidc-required-claim 标志相同。
817
+ 与 < code > --oidc-required-claim</ code > 标志相同。
810
818
仅支持用字符串声明值。
811
819
如果设置了 claim 而未设置 requiredValue,则 claim 必须存在且值必须设置为空字符串。
812
820
与 expression 和 message 互斥。
@@ -992,7 +1000,7 @@ key must be lowercase.
992
1000
Required to be unique.
993
1001
-->
994
1002
key 是用作 extra 属性键的字符串。
995
- key 必须是域前缀路径(例如 example.org/foo)。第一个 " ; /" ; 之前的所有字符必须是符合
1003
+ key 必须是域前缀路径(例如 < code > example.org/foo</ code > )。第一个 " ; /" ; 之前的所有字符必须是符合
996
1004
RFC 1123 定义的有效子域名。第一个 " ; /" ; 之后的所有字符必须是符合 RFC 3986
997
1005
定义的有效 HTTP 路径字符。
998
1006
key 必须是小写。必须是唯一的。
@@ -1015,7 +1023,7 @@ For example, a variable named 'sub' can be accessed as 'claims.sub'.
1015
1023
Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.</li>
1016
1024
</ul>
1017
1025
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
1018
- -->
1026
+ -->
1019
1027
<p >valueExpression 是一个 CEL 表达式,用于提取 extra 中的属性值。
1020
1028
valueExpression 必须生成一个字符串或字符串数组值。
1021
1029
" ;" ; 、[ ] 和 null 值被视为不存在 extra 映射。
@@ -1041,17 +1049,18 @@ Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.</li>
1041
1049
1042
1050
- [ JWTAuthenticator] ( #apiserver-k8s-io-v1alpha1-JWTAuthenticator )
1043
1051
1052
+ <p >
1044
1053
<!--
1045
- <p> Issuer provides the configuration for an external provider's specific settings.</p>
1054
+ Issuer provides the configuration for an external provider's specific settings.
1046
1055
-->
1047
- < p > Issuer 为外部提供者的特定设置提供配置。</ p >
1048
-
1056
+ Issuer 为外部提供者的特定设置提供配置。
1057
+ </ p >
1049
1058
1050
1059
<table class =" table " >
1051
1060
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
1052
1061
<tbody >
1053
-
1054
-
1062
+
1063
+
1055
1064
<tr ><td ><code >url</code > <B ><!-- [Required]--> [必需]</B ><br />
1056
1065
<code >string</code >
1057
1066
</td >
@@ -1198,31 +1207,36 @@ Allowed values are:
1198
1207
</ol >
1199
1208
<ul >
1200
1209
<li >
1210
+ <p >
1201
1211
<!--
1202
- <p> MatchAny: the "aud" claim in the presented JWT must match at least one of the entries in the "audiences" field.
1203
- For example, if "audiences" is ["foo", "bar"], the "aud" claim in the presented JWT must contain either "foo" or "bar" (and may contain both).</p>
1212
+ MatchAny: the "aud" claim in the presented JWT must match at least one of the entries in the "audiences" field.
1213
+ For example, if "audiences" is ["foo", "bar"], the "aud" claim in the presented JWT must contain either "foo" or "bar" (and may contain both).
1204
1214
-->
1205
- < p > MatchAny:所提供的 JWT 中的 " ; aud" ; 声明必须至少与 " ; audiences" ;
1215
+ MatchAny:所提供的 JWT 中的 " ; aud" ; 声明必须至少与 " ; audiences" ;
1206
1216
字段中的一个条目匹配。例如,如果 " ; audiences" ; 是 [ " ; foo" ; , " ; bar" ; ] ,
1207
1217
则所提供的 JWT 中的 " ; aud" ; 声明必须包含 " ; foo" ; 或 " ; bar" ; (也可以同时包含两者)。
1208
1218
</p >
1209
1219
</li >
1210
1220
<li >
1221
+ <p >
1211
1222
<!--
1212
- <p> "": The match policy can be empty (or unset) when a single audience is specified in the "audiences" field. The "aud" claim in the presented JWT must contain the single audience (and may contain others).</p>
1223
+ "": The match policy can be empty (or unset) when a single audience is specified in the "audiences" field. The "aud" claim in the presented JWT must contain the single audience (and may contain others).
1213
1224
-->
1214
- <p >" ;" ; :当 " ; audiences" ; 字段中指定单个受众时,匹配策略可以为空(或未设置)。
1215
- 所提供的 JWT 中的 " ; aud" ; 声明必须包含该单个受众(并且可以包含其他受众)。</p >
1225
+ " ;" ; :当 " ; audiences" ; 字段中指定单个受众时,匹配策略可以为空(或未设置)。
1226
+ 所提供的 JWT 中的 " ; aud" ; 声明必须包含该单个受众(并且可以包含其他受众)。
1227
+ </p >
1216
1228
</li >
1217
1229
</ul >
1230
+ <p >
1218
1231
<!--
1219
- <p> For more nuanced audience validation, use claimValidationRules.
1220
- example: claimValidationRule[].expression: 'sets.equivalent(claims.aud, ["bar", "foo", "baz"])' to require an exact match.</p>
1232
+ For more nuanced audience validation, use claimValidationRules.
1233
+ example: claimValidationRule[].expression: 'sets.equivalent(claims.aud, ["bar", "foo", "baz"])' to require an exact match.
1221
1234
-->
1222
- < p > 对于更精细的受众验证,请使用 claimValidationRules。
1235
+ 对于更精细的受众验证,请使用 claimValidationRules。
1223
1236
示例:claimValidationRule[ ] .expression:
1224
1237
'sets.equivalent(claims.aud, [ " ; bar" ; , " ; foo" ; , " ; baz" ; ] )'
1225
- 以要求精确匹配。</p >
1238
+ 以要求精确匹配。
1239
+ </p >
1226
1240
</td >
1227
1241
</tr >
1228
1242
</tbody >
@@ -1318,7 +1332,7 @@ The validation rules are logically ANDed together and must all return true for t
1318
1332
<table class =" table " >
1319
1333
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
1320
1334
<tbody >
1321
-
1335
+
1322
1336
<tr ><td ><code >claim</code ><br />
1323
1337
<code >string</code >
1324
1338
</td >
@@ -1590,7 +1604,7 @@ UDSTransport 设置通过 UDS 连接 konnectivity 服务器时需要的信息。
1590
1604
<tbody >
1591
1605
1592
1606
1593
- <tr ><td ><code >udsName</code > <B >[必需]</B ><br />
1607
+ <tr ><td ><code >udsName</code > <B ><!-- [Required] --> [必需]</B ><br />
1594
1608
<code >string</code >
1595
1609
</td >
1596
1610
<td >
@@ -1687,7 +1701,7 @@ API 文档:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28
1687
1701
<table class =" table " >
1688
1702
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
1689
1703
<tbody >
1690
-
1704
+
1691
1705
<tr ><td ><code >authorizedTTL</code > <B ><!-- [Required]--> [必需]</B ><br />
1692
1706
<a href =" https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration " ><code >meta/v1.Duration</code ></a >
1693
1707
</td >
@@ -1745,7 +1759,7 @@ Same as setting <code>--authorization-webhook-version</code> flag
1745
1759
Valid values: v1beta1, v1
1746
1760
Required, no default value</p>
1747
1761
-->
1748
- <p >要发送到 Webhook 并期望从 Webhook 获得的 authorization.k8s.io SubjectAccessReview 的 API 版本。
1762
+ <p >要发送到 Webhook 并期望从 Webhook 获得的 < code > authorization.k8s.io</ code > SubjectAccessReview 的 API 版本。
1749
1763
与设置 <code >--authorization-webhook-version</code > 标志相同。
1750
1764
有效值:v1beta1、v1。必需,无默认值</p >
1751
1765
</td >
@@ -1905,8 +1919,8 @@ Required, if connectionInfo.Type is KubeConfig
1905
1919
<table class =" table " >
1906
1920
<thead ><tr ><th width =" 30% " ><!-- Field--> 字段</th ><th ><!-- Description--> 描述</th ></tr ></thead >
1907
1921
<tbody >
1908
-
1909
-
1922
+
1923
+
1910
1924
<tr ><td ><code >expression</code > <B ><!-- [Required]--> [必需]</B ><br />
1911
1925
<code >string</code >
1912
1926
</td >
0 commit comments