Skip to content

Commit 4953d2b

Browse files
authored
Merge pull request #45677 from tenzen-y/job-success-policy-follow-ups
KEP-3998: Rephrase JobSuccessPolicy documentations
2 parents deb1be8 + f12b68a commit 4953d2b

File tree

1 file changed

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

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@ These are some situations where you might want additional control for declaring
573573

574574
You can configure a success policy, in the `.spec.successPolicy` field,
575575
to meet the above use cases. This policy can handle Job success based on the
576-
succeeded pods. After the Job meet success policy, the job controller terminates the lingering Pods.
576+
succeeded pods. After the Job meets the 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,
@@ -592,10 +592,10 @@ Here is a manifest for a Job with `successPolicy`:
592592

593593
{{% code_sample file="/controllers/job-success-policy.yaml" %}}
594594

595-
In the example above, the rule of the success policy specifies that
596-
the Job should be marked succeeded and terminate the lingering Pods
597-
if one of the 0, 2, and 3 indexes succeeded.
598-
The Job that met the success policy gets the `SuccessCriteriaMet` condition.
595+
In the example above, both `succeededIndexes` and `succeededCount` have been specified.
596+
Therefore, the job controller will mark the Job as succeeded and terminate the lingering Pods
597+
when either of the specified indexes, 0, 2, or 3, succeed.
598+
The Job that meets the success policy gets the `SuccessCriteriaMet` condition.
599599
After the removal of the lingering Pods is issued, the Job gets the `Complete` condition.
600600

601601
Note that the `succeededIndexes` is represented as intervals separated by a hyphen.

0 commit comments

Comments
 (0)