CronJob
CronJob 管理基于时间的 Job,即:
- 在给定时间点只运行一次
- 周期性地在给定时间点运行
一个 CronJob 对象类似于 crontab(cron table)文件中的一行。它根据指定的预定计划周期性地运行一个 Job,格式可以参考 Cron。
前提条件
CronJob 自 Kubernetes v1.21 起已成为稳定版本(batch/v1
),在所有受支持的 Kubernetes 版本中均可直接使用。
典型用例
- 在指定时间点运行一次性任务
- 创建周期性运行的任务,例如:
- 数据库备份
- 发送报告邮件
- 清理临时文件
- 健康检查
CronJob 规格说明
必需字段
可选字段
.spec.startingDeadlineSeconds
:启动 Job 的期限(秒)。如果因任何原因错过调度时间,超过此期限的 Job 将被视为失败。未指定则无期限限制.spec.concurrencyPolicy
:并发策略,指定如何处理 CronJob 创建的 Job 的并发执行:Allow
(默认):允许并发运行 JobForbid
:禁止并发运行,如果前一个未完成,则跳过下一个Replace
:取消当前运行的 Job,用新的替换
注意
并发策略仅适用于同一个 CronJob 创建的 Job。不同 CronJob 之间创建的 Job 总是允许并发运行。
.spec.suspend
:挂起标志,设置为true
时,后续所有执行都会被挂起。对已开始执行的 Job 不起作用。默认值为false
.spec.successfulJobsHistoryLimit
和.spec.failedJobsHistoryLimit
:历史记录限制,指定保留多少个完成和失败的 Job- 默认值分别为
3
和1
- 设置为
0
表示完成后不保留相关类型的 Job
- 默认值分别为
创建 CronJob
使用 YAML 文件
以下是具体的使用方法:
apiVersion: batch/v1
kind: CronJob
metadata:
name: hello
spec:
schedule: "*/1 * * * *"
jobTemplate:
spec:
template:
spec:
containers:
- name: hello
image: busybox:1.35
args:
- /bin/sh
- -c
- date; echo Hello from the Kubernetes cluster
restartPolicy: OnFailure
kubectl apply -f cronjob.yaml
使用 kubectl 命令
以下是具体的使用方法:
kubectl create cronjob hello --schedule="*/1 * * * *" --image=busybox:1.35 -- /bin/sh -c "date; echo Hello from the Kubernetes cluster"
管理 CronJob
查看 CronJob 状态
以下是相关的代码示例:
$ kubectl get cronjob
NAME SCHEDULE SUSPEND ACTIVE LAST SCHEDULE AGE
hello */1 * * * * False 0 <none> 10s
$ kubectl describe cronjob hello
查看相关 Job 和 Pod
以下是相关的代码示例:
$ kubectl get jobs
NAME READY STATUS RESTARTS AGE
hello-1202039034 0/1 Completed 0 49s
$ kubectl get pods --selector=job-name=hello-1202039034
NAME READY STATUS RESTARTS AGE
hello-1202039034-x7db5 0/1 Completed 0 49s
$ kubectl logs hello-1202039034-x7db5
Mon Aug 29 21:34:09 UTC 2023
Hello from the Kubernetes cluster
CronJob 限制和注意事项
调度可靠性
CronJob 在每次调度时间内大概会创建一个 Job 对象。说大概是因为在特定环境下可能会:
- 创建两个 Job
- 一个 Job 都没创建
因此,Job 操作应该设计为幂等的。
时区处理
CronJob 调度基于控制平面运行的时区。如果控制平面在不同时区的多个节点上运行,调度时间可能会不可预测。
Job 管理职责
- Job 负责重试创建 Pod,并决定 Pod 组的成功或失败
- CronJob 不会检查 Pod 的状态
删除 CronJob
删除 CronJob 资源
以下是相关的代码示例:
kubectl delete cronjob hello
重要
删除 CronJob 不会自动删除其创建的 Job 和 Pod。需要手动清理。
清理相关资源
以下是相关的代码示例:
# 列出所有相关 Job
$ kubectl get jobs
NAME READY STATUS RESTARTS AGE
hello-1201907962 0/1 Completed 0 11m
hello-1202039034 0/1 Completed 0 8m
# 删除指定 Job
$ kubectl delete job hello-1201907962 hello-1202039034
# 或删除所有 Job(谨慎使用)
$ kubectl delete jobs --all
批量清理脚本
以下是相关的代码示例:
# 删除特定 CronJob 创建的所有 Job
kubectl delete jobs -l job-name --selector='job-name=hello'
# 删除超过一定时间的已完成 Job
kubectl delete job $(kubectl get job -o jsonpath='{.items[?(@.status.conditions[0].type=="Complete")].metadata.name}')
最佳实践
- 设置资源限制:为 Job 模板中的容器设置适当的资源请求和限制
- 配置重试策略:合理设置
restartPolicy
和backoffLimit
- 监控和告警:监控 CronJob 的执行状态和失败情况
- 日志管理:确保容器日志能够被适当收集和保存
- 幂等性:确保 Job 执行是幂等的,避免重复执行造成问题
- 清理策略:定期清理历史 Job,避免资源累积