Skip to content

Commit 7465256

Browse files
committed
KEP-3998: Aldo's second suggestions
Signed-off-by: Yuki Iwai <[email protected]>
1 parent d79de02 commit 7465256

File tree

1 file changed

+6
-6
lines changed
  • content/en/docs/concepts/workloads/controllers

1 file changed

+6
-6
lines changed

content/en/docs/concepts/workloads/controllers/job.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -572,21 +572,21 @@ These are some situations where you might want additional control for declaring
572572
failure of a Job. Examples of this are frameworks like MPI and PyTorch etc.
573573

574574
You can configure a success policy, in the `.spec.successPolicy` field,
575-
to meet the above use cases. This policy can handle Job successes based on the
575+
to meet the above use cases. This policy can handle Job success based on the
576576
succeeded pods. After the Job meet success policy, the job controller terminates the lingering Pods.
577577
A success policy is defined by rules. Each rule can take one of the following forms:
578578

579579
* When you specify the `succeededIndexes` only,
580-
once all indexes specified in the `succeededIndexes` succeeded, the Job is marked as succeeded.
580+
once all indexes specified in the `succeededIndexes` succeed, the job controller marks the Job as succeeded.
581581
The `succeededIndexes` must be a list of intervals between 0 and `.spec.completions-1`.
582582
* When you specify the `succeededCount` only,
583-
once the number of succeeded indexes reaches the `succeededCount`, the Job is marked as succeeded.
583+
once the number of succeeded indexes reaches the `succeededCount`, the job controller marks the Job as succeeded.
584584
* When you specify both `succeededIndexes` and `succeededCount`,
585-
once the number of succeeded indexes specified in the `succeededIndexes` reaches the `succeededCount`,
586-
the Job is marked as succeeded.
585+
once the number of succeeded indexes from the subset of indexes specified in the `succeededIndexes` reaches the `succeededCount`,
586+
the job controller marks the Job as succeeded.
587587

588588
Note that when you specify multiple rules in the `.spec.succeessPolicy.rules`,
589-
the rules are evaluated in order. Once the Job meets a rule, the remaining rules are ignored.
589+
the job controller evaluates the rules in order. Once the Job meets a rule, the job controller ignores remaining rules.
590590

591591
Here is a manifest for a Job with `successPolicy`:
592592

0 commit comments

Comments
 (0)