作业
Job 创建一个或多个 Pod,并将继续重试 Pod 的执行,直到指定数量的 Pod 成功终止。当 Pod 成功完成时,Job 会跟踪成功的完成次数。当达到指定的成功完成次数时,任务(即 Job)就完成了。删除 Job 将清理它创建的 Pod。暂停 Job 将删除其活动的 Pod,直到 Job 再次恢复。
一个简单的例子是创建一个 Job 对象,以便可靠地运行一个 Pod 直到完成。如果第一个 Pod 失败或被删除(例如由于节点硬件故障或节点重启),则 Job 对象将启动一个新的 Pod。
你也可以使用 Job 并行运行多个 Pod。
如果你想按计划运行一个 Job(单个任务或多个并行任务),请参阅 CronJob。
运行示例 Job
这是一个 Job 配置示例。它计算 π 到 2000 位并打印出来。它大约需要 10 秒才能完成。
apiVersion: batch/v1
kind: Job
metadata:
name: pi
spec:
template:
spec:
containers:
- name: pi
image: perl:5.34.0
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
backoffLimit: 4
你可以使用此命令运行示例
kubectl apply -f https://kubernetes.ac.cn/examples/controllers/job.yaml
输出类似于这样
job.batch/pi created
使用 kubectl
检查 Job 的状态
Name: pi
Namespace: default
Selector: batch.kubernetes.io/controller-uid=c9948307-e56d-4b5d-8302-ae2d7b7da67c
Labels: batch.kubernetes.io/controller-uid=c9948307-e56d-4b5d-8302-ae2d7b7da67c
batch.kubernetes.io/job-name=pi
...
Annotations: batch.kubernetes.io/job-tracking: ""
Parallelism: 1
Completions: 1
Start Time: Mon, 02 Dec 2019 15:20:11 +0200
Completed At: Mon, 02 Dec 2019 15:21:16 +0200
Duration: 65s
Pods Statuses: 0 Running / 1 Succeeded / 0 Failed
Pod Template:
Labels: batch.kubernetes.io/controller-uid=c9948307-e56d-4b5d-8302-ae2d7b7da67c
batch.kubernetes.io/job-name=pi
Containers:
pi:
Image: perl:5.34.0
Port: <none>
Host Port: <none>
Command:
perl
-Mbignum=bpi
-wle
print bpi(2000)
Environment: <none>
Mounts: <none>
Volumes: <none>
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal SuccessfulCreate 21s job-controller Created pod: pi-xf9p4
Normal Completed 18s job-controller Job completed
apiVersion: batch/v1
kind: Job
metadata:
annotations: batch.kubernetes.io/job-tracking: ""
...
creationTimestamp: "2022-11-10T17:53:53Z"
generation: 1
labels:
batch.kubernetes.io/controller-uid: 863452e6-270d-420e-9b94-53a54146c223
batch.kubernetes.io/job-name: pi
name: pi
namespace: default
resourceVersion: "4751"
uid: 204fb678-040b-497f-9266-35ffa8716d14
spec:
backoffLimit: 4
completionMode: NonIndexed
completions: 1
parallelism: 1
selector:
matchLabels:
batch.kubernetes.io/controller-uid: 863452e6-270d-420e-9b94-53a54146c223
suspend: false
template:
metadata:
creationTimestamp: null
labels:
batch.kubernetes.io/controller-uid: 863452e6-270d-420e-9b94-53a54146c223
batch.kubernetes.io/job-name: pi
spec:
containers:
- command:
- perl
- -Mbignum=bpi
- -wle
- print bpi(2000)
image: perl:5.34.0
imagePullPolicy: IfNotPresent
name: pi
resources: {}
terminationMessagePath: /dev/termination-log
terminationMessagePolicy: File
dnsPolicy: ClusterFirst
restartPolicy: Never
schedulerName: default-scheduler
securityContext: {}
terminationGracePeriodSeconds: 30
status:
active: 1
ready: 0
startTime: "2022-11-10T17:53:57Z"
uncountedTerminatedPods: {}
要查看 Job 已完成的 Pod,请使用 kubectl get pods
。
要以机器可读的形式列出属于 Job 的所有 Pod,可以使用如下命令
pods=$(kubectl get pods --selector=batch.kubernetes.io/job-name=pi --output=jsonpath='{.items[*].metadata.name}')
echo $pods
输出类似于这样
pi-5rwd7
这里,选择器与 Job 的选择器相同。--output=jsonpath
选项指定一个表达式,该表达式包含返回列表中的每个 Pod 的名称。
查看其中一个 Pod 的标准输出
kubectl logs $pods
查看 Job 日志的另一种方法
kubectl logs jobs/pi
输出类似于这样
3.1415926535897932384626433832795028841971693993751058209749445923078164062862089986280348253421170679821480865132823066470938446095505822317253594081284811174502841027019385211055596446229489549303819644288109756659334461284756482337867831652712019091456485669234603486104543266482133936072602491412737245870066063155881748815209209628292540917153643678925903600113305305488204665213841469519415116094330572703657595919530921861173819326117931051185480744623799627495673518857527248912279381830119491298336733624406566430860213949463952247371907021798609437027705392171762931767523846748184676694051320005681271452635608277857713427577896091736371787214684409012249534301465495853710507922796892589235420199561121290219608640344181598136297747713099605187072113499999983729780499510597317328160963185950244594553469083026425223082533446850352619311881710100031378387528865875332083814206171776691473035982534904287554687311595628638823537875937519577818577805321712268066130019278766111959092164201989380952572010654858632788659361533818279682303019520353018529689957736225994138912497217752834791315155748572424541506959508295331168617278558890750983817546374649393192550604009277016711390098488240128583616035637076601047101819429555961989467678374494482553797747268471040475346462080466842590694912933136770289891521047521620569660240580381501935112533824300355876402474964732639141992726042699227967823547816360093417216412199245863150302861829745557067498385054945885869269956909272107975093029553211653449872027559602364806654991198818347977535663698074265425278625518184175746728909777727938000816470600161452491921732172147723501414419735685481613611573525521334757418494684385233239073941433345477624168625189835694855620992192221842725502542568876717904946016534668049886272327917860857843838279679766814541009538837863609506800642251252051173929848960841284886269456042419652850222106611863067442786220391949450471237137869609563643719172874677646575739624138908658326459958133904780275901
编写 Job 规约
与所有其他 Kubernetes 配置一样,Job 需要 apiVersion
、kind
和 metadata
字段。
当控制平面为 Job 创建新的 Pod 时,Job 的 .metadata.name
是命名这些 Pod 的一部分基础。Job 的名称必须是有效的 DNS 子域名 值,但这可能会为 Pod 主机名产生意外的结果。为了获得最佳兼容性,名称应遵循更严格的 DNS 标签 规则。即使名称是 DNS 子域名,名称的长度也不得超过 63 个字符。
Job 也需要一个 .spec
部分。
Job 标签
Job 标签将具有 batch.kubernetes.io/
前缀,用于 job-name
和 controller-uid
。
Pod 模板
.spec.template
是 .spec
的唯一必填字段。
.spec.template
是一个 Pod 模板。它与 Pod 具有完全相同的模式,只是它是嵌套的,并且没有 apiVersion
或 kind
。
除了 Pod 的必填字段外,Job 中的 Pod 模板还必须指定适当的标签(请参阅 Pod 选择器)和适当的重启策略。
只允许 RestartPolicy
等于 Never
或 OnFailure
。
Pod 选择器
.spec.selector
字段是可选的。在几乎所有情况下,你都不应该指定它。请参阅 指定你自己的 Pod 选择器部分。
Job 的并行执行
有三种主要类型的任务适合作为 Job 运行
- 非并行 Job
- 通常,只启动一个 Pod,除非该 Pod 失败。
- 只要它的 Pod 成功终止,Job 就完成了。
- 具有固定完成计数的并行 Job
- 为
.spec.completions
指定一个非零正值。 - Job 表示整体任务,当有
.spec.completions
个成功的 Pod 时,该 Job 就完成了。 - 当使用
.spec.completionMode="Indexed"
时,每个 Pod 在 0 到.spec.completions-1
的范围内获得不同的索引。
- 为
- 具有工作队列的并行 Job
- 不要指定
.spec.completions
,默认为.spec.parallelism
。 - Pod 必须在它们之间或外部服务之间进行协调,以确定每个 Pod 应该处理什么。例如,Pod 可能会从工作队列中获取一批最多 N 个项目。
- 每个 Pod 都能独立确定其所有对等 Pod 是否完成,从而确定整个 Job 是否完成。
- 当 Job 中的任何 Pod 成功终止时,不会创建新的 Pod。
- 一旦至少一个 Pod 成功终止并且所有 Pod 都终止,则 Job 就成功完成。
- 一旦任何 Pod 成功退出,其他 Pod 都不应再为此任务执行任何工作或写入任何输出。它们都应该在退出的过程中。
- 不要指定
对于非并行 Job,你可以将 .spec.completions
和 .spec.parallelism
都保留为未设置。当两者都未设置时,两者都默认为 1。
对于固定完成计数 Job,你应该将 .spec.completions
设置为所需的完成次数。你可以设置 .spec.parallelism
,或者将其保留为未设置,它将默认为 1。
对于工作队列 Job,你必须将 .spec.completions
保留为未设置,并将 .spec.parallelism
设置为非负整数。
有关如何使用不同类型的 Job 的更多信息,请参阅 Job 模式 部分。
控制并行度
请求的并行度 (.spec.parallelism
) 可以设置为任何非负值。如果未指定,则默认为 1。如果指定为 0,则 Job 将有效地暂停,直到它增加。
由于多种原因,实际并行度(在任何时刻运行的 Pod 数量)可能多于或少于请求的并行度
- 对于固定完成计数 Job,并行运行的 Pod 的实际数量不会超过剩余完成次数。较高的
.spec.parallelism
值实际上会被忽略。 - 对于工作队列 Job,在任何 Pod 成功后都不会启动新的 Pod - 但是,允许剩余的 Pod 完成。
- 如果 Job 控制器没有时间做出反应。
- 如果 Job 控制器由于任何原因(缺少
ResourceQuota
、缺少权限等)而未能创建 Pod,则 Pod 数量可能少于请求的数量。 - 由于同一 Job 中以前的 Pod 失败次数过多,Job 控制器可能会限制新的 Pod 创建。
- 当 Pod 正常关闭时,需要时间停止。
完成模式
Kubernetes v1.24 [稳定版]
具有固定完成计数的 Job - 即具有非空 .spec.completions
的 Job - 可以具有在 .spec.completionMode
中指定的完成模式
NonIndexed
(默认):当有.spec.completions
个成功完成的 Pod 时,该 Job 被视为完成。换句话说,每个 Pod 的完成彼此同源。请注意,具有空.spec.completions
的 Job 隐式为NonIndexed
。Indexed
:Job 的 Pod 从 0 到.spec.completions-1
获得关联的完成索引。可以通过四种机制获得索引- Pod 注解
batch.kubernetes.io/job-completion-index
。 - Pod 标签
batch.kubernetes.io/job-completion-index
(适用于 v1.28 及更高版本)。请注意,必须启用特性门控PodIndexLabel
才能使用此标签,并且默认情况下已启用。 - 作为 Pod 主机名的一部分,遵循
$(job-name)-$(index)
模式。当您将索引作业与服务结合使用时,作业中的 Pod 可以使用确定性的主机名通过 DNS 互相寻址。有关如何配置此项的更多信息,请参阅Pod 之间通信的作业。 - 来自容器化的任务,位于环境变量
JOB_COMPLETION_INDEX
中。
当每个索引都成功完成一个 Pod 时,该作业被认为是完成的。有关如何使用此模式的更多信息,请参阅静态工作分配的并行处理索引作业。
- Pod 注解
注意
尽管很少见,但对于同一个索引可能会启动多个 Pod(由于各种原因,例如节点故障、kubelet 重启或 Pod 驱逐)。在这种情况下,只有第一个成功完成的 Pod 才会计入完成计数并更新作业的状态。一旦检测到,同一索引的其他正在运行或已完成的 Pod 将被作业控制器删除。处理 Pod 和容器故障
Pod 中的容器可能由于多种原因而失败,例如其中的进程以非零退出代码退出,或者容器因超出内存限制而被杀死等。如果发生这种情况,并且 .spec.template.spec.restartPolicy = "OnFailure"
,则 Pod 会保留在节点上,但容器会重新运行。因此,您的程序需要处理它在本地重新启动的情况,或者指定 .spec.template.spec.restartPolicy = "Never"
。有关 restartPolicy
的更多信息,请参阅pod 生命周期。
整个 Pod 也可能由于多种原因而失败,例如当 Pod 被从节点上踢出(节点升级、重启、删除等),或者如果 Pod 的容器失败且 .spec.template.spec.restartPolicy = "Never"
。当 Pod 失败时,作业控制器会启动一个新的 Pod。这意味着您的应用程序需要处理它在新 Pod 中重新启动的情况。特别是,它需要处理先前运行导致的临时文件、锁、未完成的输出等。
默认情况下,每次 Pod 失败都会计入 .spec.backoffLimit
限制,请参阅pod 退避失败策略。但是,您可以通过设置作业的pod 失败策略来自定义 Pod 故障的处理方式。
此外,您可以通过设置 .spec.backoffLimitPerIndex
字段来选择单独计算索引作业的每个索引的 Pod 失败次数(有关更多信息,请参阅每个索引的退避限制)。
请注意,即使您指定 .spec.parallelism = 1
和 .spec.completions = 1
以及 .spec.template.spec.restartPolicy = "Never"
,同一个程序有时也可能会启动两次。
如果您指定 .spec.parallelism
和 .spec.completions
都大于 1,则可能会有多个 Pod 同时运行。因此,您的 Pod 还必须能够容忍并发。
如果您指定 .spec.podFailurePolicy
字段,作业控制器不会将正在终止的 Pod(设置了 .metadata.deletionTimestamp
字段的 Pod)视为失败,直到该 Pod 终止(其 .status.phase
为 Failed
或 Succeeded
)。但是,一旦终止变得明显,作业控制器就会创建一个替换 Pod。一旦 Pod 终止,作业控制器会评估相关作业的 .backoffLimit
和 .podFailurePolicy
,并将现在已终止的 Pod 考虑在内。
如果这两个要求中的任何一个未满足,则作业控制器会将正在终止的 Pod 视为立即失败,即使该 Pod 稍后以 phase: "Succeeded"
终止。
Pod 退避失败策略
在某些情况下,您可能希望在多次重试后由于配置中的逻辑错误等而导致作业失败。为此,请设置 .spec.backoffLimit
来指定在将作业视为失败之前的重试次数。退避限制默认设置为 6。与作业关联的失败 Pod 将由作业控制器以指数退避延迟(10 秒、20 秒、40 秒...)重新创建,上限为 6 分钟。
重试次数以两种方式计算
.status.phase = "Failed"
的 Pod 数量。- 当使用
restartPolicy = "OnFailure"
时,.status.phase
等于Pending
或Running
的 Pod 的所有容器中的重试次数。
如果任何一个计算达到 .spec.backoffLimit
,则认为该作业失败。
注意
如果您的作业具有restartPolicy = "OnFailure"
,请记住,一旦达到作业退避限制,运行该作业的 Pod 将被终止。这可能会使调试作业的可执行文件更加困难。我们建议在调试作业时设置 restartPolicy = "Never"
或使用日志记录系统,以确保不会意外丢失来自失败作业的输出。每个索引的退避限制
Kubernetes v1.29 [beta]
当您运行索引作业时,您可以选择为每个索引单独处理 Pod 失败的重试。为此,请设置 .spec.backoffLimitPerIndex
来指定每个索引的最大 Pod 失败次数。
当某个索引的每个索引退避限制超出时,Kubernetes 会将该索引视为失败,并将其添加到 .status.failedIndexes
字段。成功的索引(那些成功执行 Pod 的索引)会记录在 .status.completedIndexes
字段中,无论您是否设置了 backoffLimitPerIndex
字段。
请注意,失败的索引不会中断其他索引的执行。一旦您为某个作业指定了每个索引的退避限制,并且该作业的所有索引都完成,如果至少有一个索引失败,则作业控制器会将整个作业标记为失败,方法是在状态中设置失败条件。即使某些索引(可能几乎所有索引)都已成功处理,该作业也会被标记为失败。
您还可以通过设置 .spec.maxFailedIndexes
字段来限制标记为失败的最大索引数。当失败索引的数量超过 maxFailedIndexes
字段时,作业控制器会触发终止该作业的所有剩余运行 Pod。一旦所有 Pod 都终止,则整个作业将被作业控制器标记为失败,方法是在作业状态中设置失败条件。
以下是定义 backoffLimitPerIndex
的作业示例清单
apiVersion: batch/v1
kind: Job
metadata:
name: job-backoff-limit-per-index-example
spec:
completions: 10
parallelism: 3
completionMode: Indexed # required for the feature
backoffLimitPerIndex: 1 # maximal number of failures per index
maxFailedIndexes: 5 # maximal number of failed indexes before terminating the Job execution
template:
spec:
restartPolicy: Never # required for the feature
containers:
- name: example
image: python
command: # The jobs fails as there is at least one failed index
# (all even indexes fail in here), yet all indexes
# are executed as maxFailedIndexes is not exceeded.
- python3
- -c
- |
import os, sys
print("Hello world")
if int(os.environ.get("JOB_COMPLETION_INDEX")) % 2 == 0:
sys.exit(1)
在上面的示例中,作业控制器允许每个索引重启一次。当失败索引的总数超过 5 个时,则整个作业被终止。
作业完成后,作业状态如下所示
kubectl get -o yaml job job-backoff-limit-per-index-example
status:
completedIndexes: 1,3,5,7,9
failedIndexes: 0,2,4,6,8
succeeded: 5 # 1 succeeded pod for each of 5 succeeded indexes
failed: 10 # 2 failed pods (1 retry) for each of 5 failed indexes
conditions:
- message: Job has failed indexes
reason: FailedIndexes
status: "True"
type: FailureTarget
- message: Job has failed indexes
reason: FailedIndexes
status: "True"
type: Failed
作业控制器会添加 FailureTarget
作业条件以触发作业终止和清理。当所有作业 Pod 都终止时,作业控制器会添加 Failed
条件,其 reason
和 message
的值与 FailureTarget
作业条件的值相同。有关详细信息,请参阅作业 Pod 的终止。
此外,您可能希望将每个索引的退避与pod 失败策略一起使用。当使用每个索引的退避时,会有一个新的 FailIndex
操作可用,它允许您避免索引内不必要的重试。
Pod 失败策略
Kubernetes v1.31 [stable]
(默认启用:true)使用 .spec.podFailurePolicy
字段定义的 Pod 失败策略使您的集群能够根据容器退出代码和 Pod 条件处理 Pod 失败。
在某些情况下,您可能希望在处理 Pod 失败时获得比Pod 退避失败策略提供的控制更好的控制,该策略基于作业的 .spec.backoffLimit
。以下是一些用例示例
- 为了优化运行工作负载的成本,避免不必要的 Pod 重启,您可以立即终止作业,只要它的其中一个 Pod 因指示软件错误的退出代码而失败。
- 为了保证您的作业即使在发生中断的情况下也能完成,您可以忽略由中断(例如抢占、API 发起的驱逐或基于污点的驱逐)引起的 Pod 失败,从而使它们不计入
.spec.backoffLimit
重试次数限制。
您可以在 .spec.podFailurePolicy
字段中配置 Pod 失败策略,以满足上述用例。此策略可以根据容器退出代码和 Pod 条件处理 Pod 失败。
以下是定义 podFailurePolicy
的作业清单
apiVersion: batch/v1
kind: Job
metadata:
name: job-pod-failure-policy-example
spec:
completions: 12
parallelism: 3
template:
spec:
restartPolicy: Never
containers:
- name: main
image: docker.io/library/bash:5
command: ["bash"] # example command simulating a bug which triggers the FailJob action
args:
- -c
- echo "Hello world!" && sleep 5 && exit 42
backoffLimit: 6
podFailurePolicy:
rules:
- action: FailJob
onExitCodes:
containerName: main # optional
operator: In # one of: In, NotIn
values: [42]
- action: Ignore # one of: Ignore, FailJob, Count
onPodConditions:
- type: DisruptionTarget # indicates Pod disruption
在上面的示例中,Pod 失败策略的第一条规则指定,如果 main
容器以 42 退出代码失败,则应将作业标记为失败。以下是专门针对 main
容器的规则
- 退出代码为 0 表示容器成功
- 退出代码为 42 表示整个作业失败
- 任何其他退出代码都表示容器失败,因此整个 Pod 都失败。如果重启总数低于
backoffLimit
,则将重新创建 Pod。如果达到backoffLimit
,则整个作业失败。
注意
由于 Pod 模板指定了restartPolicy: Never
,kubelet 不会重启该特定 Pod 中的 main
容器。Pod 失败策略的第二条规则,为状态为 DisruptionTarget
的失败 Pod 指定 Ignore
操作,将 Pod 中断排除在重试次数的 .spec.backoffLimit
限制之外。
注意
如果 Job 由于 Pod 失败策略或 Pod 退避失败策略而失败,并且 Job 正在运行多个 Pod,Kubernetes 会终止该 Job 中所有仍处于 Pending 或 Running 状态的 Pod。以下是 API 的一些要求和语义
- 如果要为 Job 使用
.spec.podFailurePolicy
字段,还必须将该 Job 的 Pod 模板的.spec.restartPolicy
设置为Never
。 - 您在
spec.podFailurePolicy.rules
下指定的 Pod 失败策略规则会按顺序评估。一旦某个规则与 Pod 失败匹配,其余规则将被忽略。当没有规则与 Pod 失败匹配时,将应用默认处理。 - 您可以通过在
spec.podFailurePolicy.rules[*].onExitCodes.containerName
中指定容器的名称,将规则限制为特定容器。如果未指定,则该规则适用于所有容器。如果指定,则应与 Pod 模板中的一个容器或initContainer
名称匹配。 - 您可以指定当 Pod 失败策略匹配时采取的操作,通过
spec.podFailurePolicy.rules[*].action
指定。可能的值为:FailJob
:用于指示应将 Pod 的 Job 标记为失败,并应终止所有正在运行的 Pod。Ignore
:用于指示不应增加.spec.backoffLimit
的计数器,并且应创建替换 Pod。Count
:用于指示应以默认方式处理 Pod。应增加.spec.backoffLimit
的计数器。FailIndex
:将此操作与 每个索引的退避限制一起使用,以避免在失败的 Pod 的索引中进行不必要的重试。
注意
当您使用podFailurePolicy
时,Job 控制器仅匹配处于 Failed
阶段的 Pod。具有删除时间戳但未处于终止阶段(Failed
或 Succeeded
)的 Pod 被视为仍在终止中。这意味着终止中的 Pod 会保留一个跟踪终结器,直到它们达到终止阶段。自 Kubernetes 1.27 起,Kubelet 将删除的 Pod 转换为终止阶段(请参阅:Pod 阶段)。这确保删除的 Pod 的终结器会被 Job 控制器删除。注意
从 Kubernetes v1.28 开始,当使用 Pod 失败策略时,Job 控制器仅在这些 Pod 达到终止的Failed
阶段后才会重新创建正在终止的 Pod。此行为类似于 podReplacementPolicy: Failed
。有关更多信息,请参阅Pod 替换策略。当您使用 podFailurePolicy
,并且由于 Pod 匹配到具有 FailJob
操作的规则而导致 Job 失败时,Job 控制器会通过添加 FailureTarget
条件来触发 Job 终止过程。有关更多详细信息,请参阅Job 终止和清理。
成功策略
Kubernetes v1.31 [beta]
(默认启用:true)创建索引 Job 时,您可以根据成功的 Pod 定义何时可以使用 .spec.successPolicy
将 Job 声明为成功。
默认情况下,当成功的 Pod 数量等于 .spec.completions
时,Job 会成功。在某些情况下,您可能需要额外的控制来声明 Job 是否成功
- 当使用不同的参数运行模拟时,您可能不需要所有模拟都成功才能使整个 Job 成功。
- 当遵循领导者-工作者模式时,只有领导者的成功才能决定 Job 的成功或失败。这方面的例子有 MPI 和 PyTorch 等框架。
您可以在 .spec.successPolicy
字段中配置成功策略,以满足上述用例。此策略可以基于成功的 Pod 处理 Job 成功。在 Job 满足成功策略后,Job 控制器将终止剩余的 Pod。成功策略由规则定义。每个规则可以采用以下形式之一
- 当您仅指定
succeededIndexes
时,一旦succeededIndexes
中指定的所有索引都成功,Job 控制器会将 Job 标记为成功。succeededIndexes
必须是 0 到.spec.completions-1
之间的间隔列表。 - 当您仅指定
succeededCount
时,一旦成功的索引数达到succeededCount
,Job 控制器会将 Job 标记为成功。 - 当您同时指定
succeededIndexes
和succeededCount
时,一旦succeededIndexes
中指定的索引子集中成功的索引数达到succeededCount
,Job 控制器会将 Job 标记为成功。
请注意,当您在 .spec.successPolicy.rules
中指定多个规则时,Job 控制器会按顺序评估这些规则。一旦 Job 满足某个规则,Job 控制器将忽略其余规则。
以下是一个带有 successPolicy
的 Job 的清单
apiVersion: batch/v1
kind: Job
metadata:
name: job-success
spec:
parallelism: 10
completions: 10
completionMode: Indexed # Required for the success policy
successPolicy:
rules:
- succeededIndexes: 0,2-3
succeededCount: 1
template:
spec:
containers:
- name: main
image: python
command: # Provided that at least one of the Pods with 0, 2, and 3 indexes has succeeded,
# the overall Job is a success.
- python3
- -c
- |
import os, sys
if os.environ.get("JOB_COMPLETION_INDEX") == "2":
sys.exit(0)
else:
sys.exit(1)
restartPolicy: Never
在上面的示例中,succeededIndexes
和 succeededCount
都已指定。因此,当指定的索引 0、2 或 3 中任意一个成功时,Job 控制器将把 Job 标记为成功并终止剩余的 Pod。满足成功策略的 Job 将获得 SuccessCriteriaMet
条件,并带有 SuccessPolicy
原因。在发出删除剩余 Pod 的命令后,Job 将获得 Complete
条件。
请注意,succeededIndexes
表示为由连字符分隔的间隔。数字通过序列的第一个和最后一个元素表示,并用连字符分隔。
注意
当您同时指定成功策略和某些终止策略(例如.spec.backoffLimit
和 .spec.podFailurePolicy
)时,一旦 Job 满足任一策略,Job 控制器将遵守终止策略并忽略成功策略。Job 终止和清理
当 Job 完成时,不会创建更多的 Pod,但 Pod 通常也不会被删除。保留它们可以让您仍然查看已完成 Pod 的日志,以检查错误、警告或其他诊断输出。Job 对象在完成之后也会保留,以便您可以查看其状态。用户有责任在记录其状态后删除旧的 Job。使用 kubectl
删除 Job(例如 kubectl delete jobs/pi
或 kubectl delete -f ./job.yaml
)。当您使用 kubectl
删除 Job 时,它创建的所有 Pod 也会被删除。
默认情况下,Job 将不间断地运行,除非 Pod 失败 (restartPolicy=Never
) 或容器错误退出 (restartPolicy=OnFailure
),此时 Job 会遵循上面描述的 .spec.backoffLimit
。一旦达到 .spec.backoffLimit
,Job 将被标记为失败,并且任何正在运行的 Pod 都将被终止。
终止 Job 的另一种方法是设置活动截止时间。通过将 Job 的 .spec.activeDeadlineSeconds
字段设置为秒数来完成此操作。activeDeadlineSeconds
适用于 Job 的持续时间,无论创建了多少 Pod。一旦 Job 达到 activeDeadlineSeconds
,其所有正在运行的 Pod 都将被终止,并且 Job 状态将变为 type: Failed
,reason: DeadlineExceeded
。
请注意,Job 的 .spec.activeDeadlineSeconds
优先于其 .spec.backoffLimit
。因此,即使尚未达到 backoffLimit
,正在重试一个或多个失败 Pod 的 Job 在达到 activeDeadlineSeconds
指定的时间限制后也不会部署其他 Pod。
示例
apiVersion: batch/v1
kind: Job
metadata:
name: pi-with-timeout
spec:
backoffLimit: 5
activeDeadlineSeconds: 100
template:
spec:
containers:
- name: pi
image: perl:5.34.0
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
请注意,Job 规范和 Job 内的Pod 模板规范都有一个 activeDeadlineSeconds
字段。确保您在适当的级别设置此字段。
请记住,restartPolicy
适用于 Pod,而不适用于 Job 本身:一旦 Job 状态为 type: Failed
,就不会自动重启 Job。也就是说,通过 .spec.activeDeadlineSeconds
和 .spec.backoffLimit
激活的 Job 终止机制会导致永久的 Job 失败,需要人工干预才能解决。
终止 Job 条件
Job 有两种可能的终止状态,每种状态都有相应的 Job 条件
- 成功:Job 条件
Complete
- 失败:Job 条件
Failed
Job 由于以下原因而失败
- Pod 失败的次数超过了 Job 规范中指定的
.spec.backoffLimit
。有关详细信息,请参阅Pod 退避失败策略。 - Job 运行时超过了指定的
.spec.activeDeadlineSeconds
- 使用
.spec.backoffLimitPerIndex
的索引 Job 有失败的索引。有关详细信息,请参阅每个索引的退避限制。 - Job 中失败的索引数超过了指定的
spec.maxFailedIndexes
。有关详细信息,请参阅每个索引的退避限制 - 失败的 Pod 匹配了
.spec.podFailurePolicy
中具有FailJob
操作的规则。有关 Pod 失败策略规则如何影响失败评估的详细信息,请参阅Pod 失败策略。
Job 由于以下原因而成功
- 成功的 Pod 数达到了指定的
.spec.completions
- 满足
.spec.successPolicy
中指定的条件。有关详细信息,请参阅成功策略。
在 Kubernetes v1.31 及更高版本中,Job 控制器会延迟添加终止条件 Failed
或 Complete
,直到所有 Job Pod 都终止。
在 Kubernetes v1.30 及更早版本中,Job 控制器会在触发 Job 终止过程并删除所有 Pod 终结器后立即添加 Complete
或 Failed
Job 终止条件。但是,在添加终止条件时,某些 Pod 仍在运行或终止中。
在 Kubernetes v1.31 及更高版本中,控制器仅在所有 Pod 终止后才添加 Job 终止条件。您可以通过使用 JobManagedBy
和 JobPodReplacementPolicy
(默认都启用)功能门来控制此行为。
Job Pod 的终止
在 Job 满足成功或失败条件后,Job 控制器会将 FailureTarget
条件或 SuccessCriteriaMet
条件添加到 Job 以触发 Pod 终止。
诸如 terminationGracePeriodSeconds
之类的因素可能会增加从 Job 控制器添加 FailureTarget
条件或 SuccessCriteriaMet
条件到所有 Job Pod 终止以及 Job 控制器添加终止条件(Failed
或 Complete
)之间的时间。
您可以使用 FailureTarget
或 SuccessCriteriaMet
条件来评估 Job 是否失败或成功,而无需等待控制器添加终止条件。
例如,你可能想决定何时创建一个替换失败的 Job 的新 Job。如果你在 FailureTarget
条件出现时替换失败的 Job,你的替换 Job 会更快地运行,但可能会导致失败的 Job 和替换 Job 的 Pod 同时运行,从而消耗额外的计算资源。
或者,如果你的集群资源容量有限,你可以选择等待 Job 上出现 Failed
条件,这会延迟你的替换 Job,但会确保你通过等待所有失败的 Pod 被删除来节省资源。
自动清理已完成的 Job
系统中通常不再需要已完成的 Job。将它们保留在系统中会给 API 服务器带来压力。如果 Job 由更高级别的控制器直接管理,例如 CronJobs,则 Job 可以由 CronJobs 基于指定的基于容量的清理策略进行清理。
已完成 Job 的 TTL 机制
Kubernetes v1.23 [稳定]
另一种自动清理已完成的 Job(无论是 Complete
还是 Failed
)的方法是使用 TTL 控制器为已完成的资源提供的 TTL 机制,方法是指定 Job 的 .spec.ttlSecondsAfterFinished
字段。
当 TTL 控制器清理 Job 时,它将级联删除 Job,即删除其依赖对象,例如 Pod,以及 Job 本身。请注意,当 Job 被删除时,其生命周期保证(例如 finalizers)将得到遵守。
例如
apiVersion: batch/v1
kind: Job
metadata:
name: pi-with-ttl
spec:
ttlSecondsAfterFinished: 100
template:
spec:
containers:
- name: pi
image: perl:5.34.0
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
Job pi-with-ttl
将在完成后 100
秒后自动删除。
如果该字段设置为 0
,则 Job 将在完成后立即自动删除。如果该字段未设置,则此 Job 在完成后不会被 TTL 控制器清理。
注意
建议设置 ttlSecondsAfterFinished
字段,因为未管理的 Job(你直接创建的 Job,而不是通过其他工作负载 API(如 CronJob)间接创建的 Job)的默认删除策略是 orphanDependents
,导致由未管理的 Job 创建的 Pod 在该 Job 完全删除后仍然存在。即使控制平面最终会垃圾回收已删除 Job 的 Pod,但这些残留的 Pod 有时可能会导致集群性能下降,或者在最坏的情况下,由于这种性能下降而导致集群脱机。
你可以使用 LimitRanges 和 ResourceQuotas 来限制特定命名空间可以消耗的资源量。
Job 模式
Job 对象可以用于处理一组独立但相关的工作项。这些可能是要发送的电子邮件、要渲染的帧、要转码的文件、要扫描的 NoSQL 数据库中的键范围等等。
在一个复杂的系统中,可能存在多组不同的工作项。这里我们只考虑用户希望一起管理的一组工作项——一个批处理作业。
有几种不同的并行计算模式,每种模式都有其优点和缺点。权衡之处在于:
- 每个工作项一个 Job 对象,还是所有工作项一个 Job 对象。每个工作项一个 Job 会为用户和系统管理大量 Job 对象带来一些开销。对于大量项,所有工作项一个 Job 更好。
- 创建的 Pod 数量等于工作项的数量,还是每个 Pod 可以处理多个工作项。当 Pod 的数量等于工作项的数量时,Pod 通常需要较少的修改才能适应现有代码和容器。让每个 Pod 处理多个工作项对于大量项来说更好。
- 几种方法使用工作队列。这需要运行队列服务,并对现有程序或容器进行修改,使其使用工作队列。其他方法更容易适应现有的容器化应用程序。
- 当 Job 与 无头服务 相关联时,你可以启用 Job 中的 Pod 相互通信以协作计算。
此处总结了这些权衡,其中第 2 至 4 列对应于上述权衡。模式名称也是指向示例和更详细描述的链接。
模式 | 单个 Job 对象 | Pod 少于工作项? | 使用未修改的应用? |
---|---|---|---|
每个工作项一个 Pod 的队列 | ✓ | 有时 | |
可变 Pod 数量的队列 | ✓ | ✓ | |
带有静态工作分配的索引 Job | ✓ | ✓ | |
具有 Pod 到 Pod 通信的 Job | ✓ | 有时 | 有时 |
Job 模板扩展 | ✓ |
当你使用 .spec.completions
指定完成次数时,Job 控制器创建的每个 Pod 都具有相同的 spec
。这意味着任务的所有 Pod 都将具有相同的命令行和相同的镜像、相同的卷以及(几乎)相同的环境变量。这些模式是安排 Pod 处理不同事物的不同方式。
此表显示了每种模式的 .spec.parallelism
和 .spec.completions
的必需设置。这里,W
是工作项的数量。
模式 | .spec.completions | .spec.parallelism |
---|---|---|
每个工作项一个 Pod 的队列 | W | 任意 |
可变 Pod 数量的队列 | 空 | 任意 |
带有静态工作分配的索引 Job | W | 任意 |
具有 Pod 到 Pod 通信的 Job | W | W |
Job 模板扩展 | 1 | 应为 1 |
高级用法
暂停 Job
Kubernetes v1.24 [稳定版]
创建 Job 时,Job 控制器将立即开始创建 Pod 以满足 Job 的要求,并将继续这样做直到 Job 完成。但是,你可能希望暂时暂停 Job 的执行并在以后恢复它,或者在暂停状态下启动 Job,并让自定义控制器稍后决定何时启动它们。
要暂停 Job,你可以将 Job 的 .spec.suspend
字段更新为 true;稍后,当你想要再次恢复它时,将其更新为 false。使用 .spec.suspend
设置为 true 创建 Job 将使其处于暂停状态。
当 Job 从暂停状态恢复时,其 .status.startTime
字段将重置为当前时间。这意味着当 Job 被暂停和恢复时,.spec.activeDeadlineSeconds
计时器将被停止并重置。
当你暂停 Job 时,任何没有 Completed
状态的正在运行的 Pod 将使用 SIGTERM 信号终止。Pod 的优雅终止期将得到遵守,你的 Pod 必须在此期间处理此信号。这可能涉及保存进度以供以后使用或撤消更改。以这种方式终止的 Pod 将不计入 Job 的 completions
计数。
一个处于暂停状态的示例 Job 定义可以如下所示:
kubectl get job myjob -o yaml
apiVersion: batch/v1
kind: Job
metadata:
name: myjob
spec:
suspend: true
parallelism: 1
completions: 5
template:
spec:
...
你还可以使用命令行修补 Job 来切换 Job 暂停状态。
暂停活动 Job
kubectl patch job/myjob --type=strategic --patch '{"spec":{"suspend":true}}'
恢复暂停的 Job
kubectl patch job/myjob --type=strategic --patch '{"spec":{"suspend":false}}'
Job 的状态可用于确定 Job 是否已暂停或过去是否已暂停。
kubectl get jobs/myjob -o yaml
apiVersion: batch/v1
kind: Job
# .metadata and .spec omitted
status:
conditions:
- lastProbeTime: "2021-02-05T13:14:33Z"
lastTransitionTime: "2021-02-05T13:14:33Z"
status: "True"
type: Suspended
startTime: "2021-02-05T13:13:48Z"
类型为“Suspended”且状态为“True”的 Job 条件表示 Job 已暂停;lastTransitionTime
字段可用于确定 Job 已暂停多长时间。如果该条件的状态为“False”,则表示 Job 之前已暂停,现在正在运行。如果 Job 的状态中不存在此类条件,则表示 Job 从未停止。
当 Job 被暂停和恢复时,也会创建事件。
kubectl describe jobs/myjob
Name: myjob
...
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal SuccessfulCreate 12m job-controller Created pod: myjob-hlrpl
Normal SuccessfulDelete 11m job-controller Deleted pod: myjob-hlrpl
Normal Suspended 11m job-controller Job suspended
Normal SuccessfulCreate 3s job-controller Created pod: myjob-jvb44
Normal Resumed 3s job-controller Job resumed
最后四个事件,特别是“Suspended”和“Resumed”事件,是直接切换 .spec.suspend
字段的结果。在这两个事件之间的时间里,我们看到没有创建 Pod,但是一旦 Job 恢复,Pod 创建就重新启动了。
可变调度指令
Kubernetes v1.27 [稳定]
在大多数情况下,并行 Job 希望 Pod 运行受到约束,例如都在同一个区域中,或者都在 GPU 模型 x 或 y 上,而不是两者混合。
暂停字段是实现这些语义的第一步。暂停允许自定义队列控制器决定何时启动 Job;但是,一旦 Job 被解除暂停,自定义队列控制器就无法影响 Job 的 Pod 实际落地的位置。
此功能允许在 Job 启动之前更新 Job 的调度指令,这使自定义队列控制器能够影响 Pod 的放置,同时将实际的 Pod 到节点的分配卸载到 kube-scheduler。这仅适用于从未被解除暂停的暂停 Job。
Job 的 Pod 模板中可以更新的字段包括节点亲和性、节点选择器、容忍度、标签、注释和调度门控。
指定你自己的 Pod 选择器
通常,当你创建 Job 对象时,你不会指定 .spec.selector
。系统默认逻辑会在创建 Job 时添加此字段。它选择一个选择器值,该值不会与任何其他 Job 重叠。
但是,在某些情况下,你可能需要覆盖此自动设置的选择器。为此,你可以指定 Job 的 .spec.selector
。
执行此操作时要非常小心。如果你指定一个并非该 Job 的 Pod 独有的标签选择器,并且该选择器与不相关的 Pod 匹配,则可能会删除不相关 Job 的 Pod,或者此 Job 可能会将其他 Pod 视为已完成,或者一个或两个 Job 都可能拒绝创建 Pod 或运行至完成。如果选择了一个非唯一选择器,则其他控制器(例如 ReplicationController)及其 Pod 也可能会以不可预测的方式运行。在指定 .spec.selector
时,Kubernetes 不会阻止你犯错。
以下是一个你可能希望使用此功能的案例示例。
假设 Job old
已经在运行。您希望现有的 Pod 继续运行,但希望它创建的其余 Pod 使用不同的 Pod 模板,并且 Job 拥有一个新的名称。您无法更新 Job,因为这些字段是不可更新的。因此,您删除 Job old
,但让它的 Pod 继续运行,使用 kubectl delete jobs/old --cascade=orphan
。在删除它之前,您记下它使用的选择器。
kubectl get job old -o yaml
输出类似于这样
kind: Job
metadata:
name: old
...
spec:
selector:
matchLabels:
batch.kubernetes.io/controller-uid: a8f3d00d-c6d2-11e5-9f87-42010af00002
...
然后,您创建一个名为 new
的新 Job,并显式指定相同的选择器。由于现有的 Pod 具有标签 batch.kubernetes.io/controller-uid=a8f3d00d-c6d2-11e5-9f87-42010af00002
,它们也受 Job new
控制。
您需要在新的 Job 中指定 manualSelector: true
,因为您没有使用系统通常为您自动生成的选择器。
kind: Job
metadata:
name: new
...
spec:
manualSelector: true
selector:
matchLabels:
batch.kubernetes.io/controller-uid: a8f3d00d-c6d2-11e5-9f87-42010af00002
...
新 Job 本身将具有与 a8f3d00d-c6d2-11e5-9f87-42010af00002
不同的 uid。设置 manualSelector: true
会告诉系统您知道自己在做什么,并允许这种不匹配。
使用终结器的 Job 跟踪
Kubernetes v1.26 [stable]
控制平面会跟踪属于任何 Job 的 Pod,并注意到是否有任何此类 Pod 从 API 服务器中移除。为此,Job 控制器会创建带有终结器 batch.kubernetes.io/job-tracking
的 Pod。仅当 Pod 在 Job 状态中被记录后,控制器才会移除终结器,从而允许其他控制器或用户移除 Pod。
注意
如果您观察到来自 Job 的 Pod 卡在跟踪终结器上,请参阅 我的 Pod 保持终止状态。弹性索引 Job
Kubernetes v1.31 [stable]
(默认启用:true)您可以通过同时修改 .spec.parallelism
和 .spec.completions
来伸缩索引 Job,使得 .spec.parallelism == .spec.completions
。在缩小时,Kubernetes 会删除索引较高的 Pod。
弹性索引 Job 的用例包括需要缩放索引 Job 的批处理工作负载,例如 MPI、Horovod、Ray 和 PyTorch 训练作业。
延迟创建替换 Pod
Kubernetes v1.29 [beta]
默认情况下,Job 控制器会在 Pod 失败或终止(具有删除时间戳)时立即重新创建 Pod。这意味着,在给定时间,当某些 Pod 正在终止时,Job 的运行 Pod 数量可能大于 parallelism
,或者每个索引的 Pod 数量大于一个(如果您正在使用索引 Job)。
您可以选择仅在终止的 Pod 完全终止(具有 status.phase: Failed
)时创建替换 Pod。为此,请设置 .spec.podReplacementPolicy: Failed
。默认的替换策略取决于 Job 是否设置了 podFailurePolicy
。如果 Job 没有定义 Pod 失败策略,省略 podReplacementPolicy
字段会选择 TerminatingOrFailed
替换策略:控制平面会在 Pod 删除时立即创建替换 Pod(一旦控制平面看到此 Job 的 Pod 设置了 deletionTimestamp
)。对于设置了 Pod 失败策略的 Job,默认的 podReplacementPolicy
是 Failed
,并且不允许其他值。请参阅 Pod 失败策略,了解有关 Job 的 Pod 失败策略的更多信息。
kind: Job
metadata:
name: new
...
spec:
podReplacementPolicy: Failed
...
如果您的集群启用了特性门控,您可以检查 Job 的 .status.terminating
字段。该字段的值是 Job 拥有的当前正在终止的 Pod 数量。
kubectl get jobs/myjob -o yaml
apiVersion: batch/v1
kind: Job
# .metadata and .spec omitted
status:
terminating: 3 # three Pods are terminating and have not yet reached the Failed phase
将 Job 对象的管理委托给外部控制器
Kubernetes v1.32 [beta]
(默认禁用)此特性允许您为特定的 Job 禁用内置的 Job 控制器,并将 Job 的协调委托给外部控制器。
您可以通过为 spec.managedBy
字段设置自定义值(任何非 kubernetes.io/job-controller
的值)来指示协调 Job 的控制器。该字段的值是不可变的。
注意
使用此特性时,请确保安装了该字段指示的控制器,否则 Job 可能根本不会被协调。注意
在开发外部 Job 控制器时,请注意您的控制器需要以符合 Job 对象的 API 规范和状态字段定义的方式运行。
请在 Job API 中详细查看这些内容。我们还建议您运行 Job 对象的 e2e 一致性测试,以验证您的实现。
最后,在开发外部 Job 控制器时,请确保它不使用 batch.kubernetes.io/job-tracking
终结器,该终结器为内置控制器保留。
警告
如果您正在考虑禁用JobManagedBy
特性门控,或将集群降级到未启用该特性门控的版本,请检查是否有 spec.managedBy
字段具有自定义值的 Job。如果有此类 Job,则存在操作后它们可能被两个控制器协调的风险:内置的 Job 控制器和该字段值指示的外部控制器。替代方案
裸 Pod
当运行 Pod 的节点重新启动或失败时,Pod 将被终止,并且不会重新启动。但是,Job 将创建新的 Pod 来替换终止的 Pod。因此,我们建议您使用 Job 而不是裸 Pod,即使您的应用程序只需要一个 Pod。
复制控制器
Job 是 复制控制器 的补充。复制控制器管理不应终止的 Pod(例如,Web 服务器),而 Job 管理应终止的 Pod(例如,批处理任务)。
如 Pod 生命周期 中所述,Job
仅适用于 RestartPolicy
等于 OnFailure
或 Never
的 Pod。(注意:如果未设置 RestartPolicy
,则默认值为 Always
。)
单个 Job 启动控制器 Pod
另一种模式是,单个 Job 创建一个 Pod,然后该 Pod 创建其他 Pod,充当这些 Pod 的自定义控制器。这提供了最大的灵活性,但开始使用可能有些复杂,并且与 Kubernetes 的集成较少。
此模式的一个示例是,一个 Job 启动一个 Pod,该 Pod 运行一个脚本,该脚本反过来启动一个 Spark 主控制器(请参阅 Spark 示例),运行 Spark 驱动程序,然后进行清理。
此方法的优点是整个过程获得了 Job 对象的完成保证,但保持对创建哪些 Pod 以及如何将工作分配给它们的完全控制。
下一步
- 了解有关 Pod 的信息。
- 阅读有关运行 Job 的不同方式的信息
- 使用工作队列进行粗粒度并行处理
- 使用工作队列进行细粒度并行处理
- 使用 索引 Job 进行带有静态工作分配的并行处理
- 基于模板创建多个 Job:使用扩展的并行处理
- 按照 自动清理完成的 Job 中的链接,了解有关集群如何清理已完成和/或失败任务的更多信息。
Job
是 Kubernetes REST API 的一部分。阅读 Job 对象定义,了解 Job 的 API。- 阅读有关
CronJob
的信息,您可以使用它来定义一系列将根据计划运行的 Job,类似于 UNIX 工具cron
。 - 根据逐步 示例,练习如何使用
podFailurePolicy
配置可重试和不可重试 Pod 失败的处理。