CronJob · kubernetes完整攻略

# CronJob *Cron Job* 管理基于時間的 [Job](https://kubernetes.io/docs/concepts/jobs/run-to-completion-finite-workloads/)，即： - 在給定時間點只運行一次 - 周期性地在給定時間點運行一個 CronJob 對象類似于 *crontab* （cron table）文件中的一行。它根據指定的預定計劃周期性地運行一個 Job，格式可以參考 [Cron](https://en.wikipedia.org/wiki/Cron) 。 ## 前提條件當前使用的 Kubernetes 集群，版本 >= 1.8（對 CronJob）。對于先前版本的集群，版本 < 1.8，啟動 API Server（參考 [為集群開啟或關閉 API 版本](https://kubernetes.io/docs/admin/cluster-management/#turn-on-or-off-an-api-version-for-your-cluster) 獲取更多信息）時，通過傳遞選項 `--runtime-config=batch/v2alpha1=true` 可以開啟 batch/v2alpha1 API。典型的用法如下所示： - 在給定的時間點調度 Job 運行 - 創建周期性運行的 Job，例如：數據庫備份、發送郵件。 ## CronJob Spec - `.spec.schedule`：**調度**，必需字段，指定任務運行周期，格式同 [Cron](https://en.wikipedia.org/wiki/Cron) - `.spec.jobTemplate`：**Job 模板**，必需字段，指定需要運行的任務，格式同 [Job](job.md) - `.spec.startingDeadlineSeconds` ：**啟動 Job 的期限（秒級別）**，該字段是可選的。如果因為任何原因而錯過了被調度的時間，那么錯過執行時間的 Job 將被認為是失敗的。如果沒有指定，則沒有期限 - `.spec.concurrencyPolicy`：**并發策略**，該字段也是可選的。它指定了如何處理被 Cron Job 創建的 Job 的并發執行。只允許指定下面策略中的一種： - `Allow`（默認）：允許并發運行 Job - `Forbid`：禁止并發運行，如果前一個還沒有完成，則直接跳過下一個 - `Replace`：取消當前正在運行的 Job，用一個新的來替換注意，當前策略只能應用于同一個 Cron Job 創建的 Job。如果存在多個 Cron Job，它們創建的 Job 之間總是允許并發運行。 - `.spec.suspend` ：**掛起**，該字段也是可選的。如果設置為 `true`，后續所有執行都會被掛起。它對已經開始執行的 Job 不起作用。默認值為 `false`。 - `.spec.successfulJobsHistoryLimit` 和 `.spec.failedJobsHistoryLimit` ：**歷史限制**，是可選的字段。它們指定了可以保留多少完成和失敗的 Job。默認情況下，它們分別設置為 `3` 和 `1`。設置限制的值為 `0`，相關類型的 Job 完成后將不會被保留。 ```yaml apiVersion: batch/v1beta1 kind: CronJob metadata: name: hello spec: schedule: "*/1 * * * *" jobTemplate: spec: template: spec: containers: - name: hello image: busybox args: - /bin/sh - -c - date; echo Hello from the Kubernetes cluster restartPolicy: OnFailure ``` ```Bash $ kubectl create -f cronjob.yaml cronjob "hello" created ``` 當然，也可以用`kubectl run`來創建一個CronJob： ```bash kubectl run hello --schedule="*/1 * * * *" --restart=OnFailure --image=busybox -- /bin/sh -c "date; echo Hello from the Kubernetes cluster" ``` ```bash $ kubectl get cronjob NAME SCHEDULE SUSPEND ACTIVE LAST-SCHEDULE hello */1 * * * * False 0 <none> $ kubectl get jobs NAME DESIRED SUCCESSFUL AGE hello-1202039034 1 1 49s $ pods=$(kubectl get pods --selector=job-name=hello-1202039034 --output=jsonpath={.items..metadata.name}) $ kubectl logs $pods Mon Aug 29 21:34:09 UTC 2016 Hello from the Kubernetes cluster # 注意，刪除 cronjob 的時候不會自動刪除 job，這些 job 可以用 kubectl delete job 來刪除 $ kubectl delete cronjob hello cronjob "hello" deleted ``` ## Cron Job 限制 Cron Job 在每次調度運行時間內 *大概* 會創建一個 Job 對象。我們之所以說 *大概* ，是因為在特定的環境下可能會創建兩個 Job，或者一個 Job 都沒創建。我們嘗試少發生這種情況，但卻不能完全避免。因此，創建 Job 操作應該是 *冪等的*。 Job 根據它所創建的 Pod 的并行度，負責重試創建 Pod，并就決定這一組 Pod 的成功或失敗。Cron Job 根本就不會去檢查 Pod。 ## 刪除 Cron Job 一旦不再需要 Cron Job，簡單地可以使用 `kubectl` 命令刪除它： ``` $ kubectl delete cronjob hello cronjob "hello" deleted ``` 這將會終止正在創建的 Job。然而，運行中的 Job 將不會被終止，不會刪除 Job 或它們的 Pod。為了清理那些 Job 和 Pod，需要列出該 Cron Job 創建的全部 Job，然后刪除它們： ``` $ kubectl get jobs NAME DESIRED SUCCESSFUL AGE hello-1201907962 1 1 11m hello-1202039034 1 1 8m ... $ kubectl delete jobs hello-1201907962 hello-1202039034 ... job "hello-1201907962" deleted job "hello-1202039034" deleted ... ``` 一旦 Job 被刪除，由 Job 創建的 Pod 也會被刪除。注意，所有由名稱為 “hello” 的 Cron Job 創建的 Job 會以前綴字符串 “hello-” 進行命名。如果想要刪除當前 Namespace 中的所有 Job，可以通過命令 `kubectl delete jobs --all` 立刻刪除它們。