Skip to content

Commit 6613eb1

Browse files
committed
[zh-cn]sync job-v1 /resource-claim-template-v1
Signed-off-by: xin.li <[email protected]>
1 parent a7e17db commit 6613eb1

File tree

2 files changed

+51
-50
lines changed

2 files changed

+51
-50
lines changed

content/zh-cn/docs/reference/kubernetes-api/workload-resources/job-v1.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,16 @@ JobSpec 描述了任务执行的情况。
148148
<!--
149149
- **backoffLimit** (int32)
150150
151-
Specifies the number of retries before marking this job failed. Defaults to 6
151+
Specifies the number of retries before marking this job failed. Defaults to 6, unless backoffLimitPerIndex (only Indexed Job) is specified. When backoffLimitPerIndex is specified, backoffLimit defaults to 2147483647.
152152
153153
- **activeDeadlineSeconds** (int64)
154154
155155
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
156156
-->
157157
- **backoffLimit** (int32)
158158

159-
指定标记此任务失败之前的重试次数。默认值为 6。
159+
指定标记此任务失败之前的重试次数。默认值为 6,除非指定了 backoffLimitPerIndex(仅限 Indexed Job)。
160+
指定 backoffLimitPerIndex 时,backoffLimit 默认为 2147483647。
160161

161162
- **activeDeadlineSeconds** (int64)
162163

@@ -429,7 +430,7 @@ JobSpec 描述了任务执行的情况。
429430
430431
*Atomic: will be replaced during a merge*
431432
432-
rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.
433+
rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SuccessCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.
433434
-->
434435

435436
**successPolicy 描述何时可以根据某些索引的成功将任务声明为成功。**
@@ -439,7 +440,7 @@ JobSpec 描述了任务执行的情况。
439440
**原子性:合并期间会被替换**
440441

441442
rules 表示在 `.status.succeeded >= .spec.completions` 之前将任务声明为成功的备选规则列表。
442-
一旦满足任何规则,就会添加 `SucceededCriteriaMet` 状况,并删除滞留的 Pod。
443+
一旦满足任何规则,就会添加 `SuccessCriteriaMet` 状况,并删除滞留的 Pod。
443444
此类 Pod 的最终状态具有 `Complete` 状况。此外,这些规则按顺序进行评估;
444445
一旦任务满足其中一条规则,其他规则将被忽略。最多允许 20 个元素。
445446

@@ -448,7 +449,8 @@ JobSpec 描述了任务执行的情况。
448449
*SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.*
449450
-->
450451

451-
**SuccessPolicyRule 描述了将任务声明为成功的规则。每条规则必须至少指定 `succeededIndexes``succeededCount` 之一。**
452+
**SuccessPolicyRule 描述了将任务声明为成功的规则。每条规则必须至少指定 `succeededIndexes`
453+
`succeededCount` 之一。**
452454

453455
- **successPolicy.rules.succeededCount** (int32)
454456

@@ -514,10 +516,10 @@ JobSpec 描述了任务执行的情况。
514516
-->
515517
- **maxFailedIndexes**(int32)
516518

517-
指定在 backoffLimitPerIndex 被设置时、标记 Job 为失败之前所允许的最大失败索引数。
519+
指定在 `backoffLimitPerIndex` 被设置时、标记 Job 为失败之前所允许的最大失败索引数。
518520
一旦失败的索引数超过此数值,整个 Job 将被标记为 Failed 并终止执行。
519521
如果不设置此字段(对应为 null),则作业继续执行其所有索引,且 Job 会被标记 `Complete` 状况。
520-
此字段只能在设置 backoffLimitPerIndex 时指定。此字段值可以是 null 或完成次数之内的值。
522+
此字段只能在设置 `backoffLimitPerIndex` 时指定。此字段值可以是 null 或完成次数之内的值。
521523
当完成次数大于 10^5 时,此字段是必需的且必须小于等于 10^4。
522524

523525
<!--
@@ -536,12 +538,11 @@ JobSpec 描述了任务执行的情况。
536538
- Failed:表示在创建替代的 Pod 之前,等待先前创建的 Pod 完全终止(处于 Failed 或 Succeeded 阶段)。
537539

538540
<!--
539-
When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.
541+
When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field.
540542
-->
541543
当使用 podFailurePolicy 时,Failed 是唯一允许值。
542544
当不使用 podFailurePolicy 时,允许使用 TerminatingOrFailed 和 Failed。
543-
这是一个 Beta 级别的字段。要使用此特性,请启用 JobPodReplacementPolicy 特性门控。
544-
此特性默认处于被启用状态。
545+
这是一个 Beta 级别的字段。
545546

546547
## JobStatus {#JobStatus}
547548

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
api_metadata:
3-
apiVersion: "resource.k8s.io/v1beta2"
4-
import: "k8s.io/api/resource/v1beta2"
3+
apiVersion: "resource.k8s.io/v1"
4+
import: "k8s.io/api/resource/v1"
55
kind: "ResourceClaimTemplate"
66
content_type: "api_reference"
77
description: "ResourceClaimTemplate 用于生成 ResourceClaim 对象。"
8-
title: "ResourceClaimTemplate v1beta2"
8+
title: "ResourceClaimTemplate v1"
99
weight: 17
1010
---
1111
<!--
1212
api_metadata:
13-
apiVersion: "resource.k8s.io/v1beta2"
14-
import: "k8s.io/api/resource/v1beta2"
13+
apiVersion: "resource.k8s.io/v1"
14+
import: "k8s.io/api/resource/v1"
1515
kind: "ResourceClaimTemplate"
1616
content_type: "api_reference"
1717
description: "ResourceClaimTemplate is used to produce ResourceClaim objects."
18-
title: "ResourceClaimTemplate v1beta2"
18+
title: "ResourceClaimTemplate v1"
1919
weight: 17
2020
auto_generated: true
2121
-->
2222

23-
`apiVersion: resource.k8s.io/v1beta2`
23+
`apiVersion: resource.k8s.io/v1`
2424

25-
`import "k8s.io/api/resource/v1beta2"`
25+
`import "k8s.io/api/resource/v1"`
2626

2727
## ResourceClaimTemplate {#ResourceClaimTemplate}
2828

@@ -37,7 +37,7 @@ ResourceClaimTemplate 用于生成 ResourceClaim 对象。
3737

3838
<hr>
3939

40-
- **apiVersion**: resource.k8s.io/v1beta2
40+
- **apiVersion**: resource.k8s.io/v1
4141

4242
- **kind**: ResourceClaimTemplate
4343

@@ -49,13 +49,13 @@ ResourceClaimTemplate 用于生成 ResourceClaim 对象。
4949
标准的对象元数据。
5050

5151
<!--
52-
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>), required
52+
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>), required
5353
5454
Describes the ResourceClaim that is to be generated.
5555
5656
This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
5757
-->
58-
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>),必需
58+
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>),必需
5959

6060
描述要生成的 ResourceClaim。
6161

@@ -71,11 +71,11 @@ ResourceClaimTemplateSpec 包含针对 ResourceClaim 的元数据和字段。
7171
<hr>
7272

7373
<!--
74-
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1beta2#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
74+
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
7575
7676
Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here.
7777
-->
78-
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1beta2#ResourceClaimSpec" >}}">ResourceClaimSpec</a>),必需
78+
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1#ResourceClaimSpec" >}}">ResourceClaimSpec</a>),必需
7979

8080
ResourceClaim 的规约。整个内容将不加修改地复制到从模板创建的 ResourceClaim 中。
8181
与 ResourceClaim 中相同的字段在此处也是有效的。
@@ -99,7 +99,7 @@ ResourceClaimTemplateList 是申领模板的集合。
9999

100100
<hr>
101101

102-
- **apiVersion**: resource.k8s.io/v1beta2
102+
- **apiVersion**: resource.k8s.io/v1
103103

104104
- **kind**: ResourceClaimTemplateList
105105

@@ -111,11 +111,11 @@ ResourceClaimTemplateList 是申领模板的集合。
111111
标准的列表元数据。
112112

113113
<!--
114-
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>), required
114+
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>), required
115115
116116
Items is the list of resource claim templates.
117117
-->
118-
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>),必需
118+
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>),必需
119119

120120
items 是资源申领模板的列表。
121121

@@ -136,7 +136,7 @@ ResourceClaimTemplateList 是申领模板的集合。
136136

137137
#### HTTP 请求
138138

139-
GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name}
139+
GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}
140140

141141
<!--
142142
#### Parameters
@@ -172,7 +172,7 @@ GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
172172
-->
173173
#### 响应
174174

175-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
175+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
176176

177177
401: Unauthorized
178178

@@ -185,7 +185,7 @@ GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
185185

186186
#### HTTP 请求
187187

188-
GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
188+
GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates
189189

190190
<!--
191191
#### Parameters
@@ -293,7 +293,7 @@ GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
293293
-->
294294
#### 响应
295295

296-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
296+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
297297

298298
401: Unauthorized
299299

@@ -306,7 +306,7 @@ GET /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
306306

307307
#### HTTP 请求
308308

309-
GET /apis/resource.k8s.io/v1beta2/resourceclaimtemplates
309+
GET /apis/resource.k8s.io/v1/resourceclaimtemplates
310310

311311
<!--
312312
#### Parameters
@@ -406,7 +406,7 @@ GET /apis/resource.k8s.io/v1beta2/resourceclaimtemplates
406406
-->
407407
#### 响应
408408

409-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
409+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
410410

411411
401: Unauthorized
412412

@@ -419,7 +419,7 @@ GET /apis/resource.k8s.io/v1beta2/resourceclaimtemplates
419419

420420
#### HTTP 请求
421421

422-
POST /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
422+
POST /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates
423423

424424
<!--
425425
#### Parameters
@@ -428,7 +428,7 @@ POST /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
428428
429429
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
430430
431-
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
431+
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
432432
433433
- **dryRun** (*in query*): string
434434
@@ -452,7 +452,7 @@ POST /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
452452

453453
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
454454

455-
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>,必需
455+
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>,必需
456456

457457
- **dryRun** (**查询参数**): string
458458

@@ -475,11 +475,11 @@ POST /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
475475
-->
476476
#### 响应
477477

478-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
478+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
479479

480-
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
480+
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
481481

482-
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
482+
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
483483

484484
401: Unauthorized
485485

@@ -492,7 +492,7 @@ POST /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
492492

493493
#### HTTP 请求
494494

495-
PUT /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name}
495+
PUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}
496496

497497
<!--
498498
#### Parameters
@@ -505,7 +505,7 @@ PUT /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
505505
506506
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
507507
508-
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
508+
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
509509
510510
- **dryRun** (*in query*): string
511511
@@ -533,7 +533,7 @@ PUT /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
533533

534534
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
535535

536-
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>,必需
536+
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>,必需
537537

538538
- **dryRun** (**查询参数**): string
539539

@@ -556,9 +556,9 @@ PUT /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
556556
-->
557557
#### 响应
558558

559-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
559+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
560560

561-
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
561+
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
562562

563563
401: Unauthorized
564564

@@ -571,7 +571,7 @@ PUT /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/
571571

572572
#### HTTP 请求
573573

574-
PATCH /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name}
574+
PATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}
575575

576576
<!--
577577
#### Parameters
@@ -643,9 +643,9 @@ PATCH /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplate
643643
-->
644644
#### 响应
645645

646-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
646+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
647647

648-
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
648+
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
649649

650650
401: Unauthorized
651651

@@ -658,7 +658,7 @@ PATCH /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplate
658658

659659
#### HTTP 请求
660660

661-
DELETE /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name}
661+
DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}
662662

663663
<!--
664664
#### Parameters
@@ -730,9 +730,9 @@ DELETE /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplat
730730
-->
731731
#### 响应
732732

733-
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
733+
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
734734

735-
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1beta2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
735+
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
736736

737737
401: Unauthorized
738738

@@ -745,7 +745,7 @@ DELETE /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplat
745745

746746
#### HTTP 请求
747747

748-
DELETE /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates
748+
DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates
749749

750750
<!--
751751
#### Parameters

0 commit comments

Comments
 (0)