# 创建定时任务（CronJob）
[定时任务（CronJob）](https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/cron-jobs/)是Kubernetes中用于定期执行任务的一种工作负载，类似于Linux系统的crontab，使用[Cron](https://man7.org/linux/man-pages/man8/cron.8.html)格式进行编写， 并周期性地在给定的调度时间执行Job。
CronJob适用于多种场景，帮助您自动化和管理任务，确保任务按时执行，减轻人工管理的负担。例如：
- **定期备份**：可以使用CronJob定期执行备份任务，例如数据库备份、文件系统备份等。
- **数据同步**：定期从主节点同步数据到从节点或云存储。
- **日志清理**：定期清理旧的日志文件，避免占用过多存储空间。
- **定期报告**：生成和发送定期报告，如系统状态报告、性能报告等。
- **维护任务**：执行定期的系统维护任务，如清理缓存、更新组件等。
- **定期任务调度**：在特定时间点或周期内执行特定任务，如定期重启服务、执行健康检查等。
#### 前提条件
- 在创建工作负载前，已存在一个可用集群。若没有可用集群，请参照[购买CCE Autopilot集群](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0028.html)中内容创建。
- 在创建工作负载前，已配置访问镜像中心的VPC终端节点。创建集群时，系统将自动创建对应的VPC终端节点，您可以进入集群的"概览"页，在"网络信息"模块的"镜像访问"中查看是否配置终端节点。如果集群暂未配置终端节点，请参考[配置访问镜像中心的VPC终端节点](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0461.html)进行配置。
 
#### 创建定时任务
您可以通过控制台或kubectl命令行创建定时任务。
- [通过控制台创建]
  1. 登录[CCE控制台](https://console.huaweicloud.com/cce2.0/?#/cce/cluster/list)。
  
  2. 单击集群名称进入集群，在左侧选择"工作负载"，在右上角单击"创建工作负载"。
  
  3. 填写工作负载的**基本信息** 。
     
     表1工作负载的基本信息 
     | 参数   | 说明                                                                                                                                                    |
     |:---|:---|
     | 负载类型 | 选择定时任务CronJob。关于不同工作负载类型的介绍请参见[工作负载概述](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0907.html)。                                   |
     | 负载名称    | 填写工作负载的名称。请输入1到63个字符的字符串，可以包含小写英文字母、数字和中划线（-），并以小写英文字母开头，小写英文字母或数字结尾。                                                                     |
     | 命名空间   | 选择工作负载的命名空间，默认为default。您可以单击后面的"创建命名空间"，命名空间的详细介绍请参见[创建命名空间](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0278.html)。 |
     | 实例类型  | 选择工作负载的实例类型，默认为通用型。关于实例类型的详细介绍，请参见[设置实例类型](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0908.html)。                  |
        
     
     
  
  4. 填写工作负载的**容器配置** 。
     
     - 镜像缓存（可选）：如果您已创建相关的镜像缓存，可以选择自动匹配镜像缓存或指定镜像缓存，具体参数说明请参见[镜像缓存参数说明]。使用镜像缓存可以加速镜像下载，提升负载的启动速度，详情请参见[镜像缓存概述](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0157.html)。当集群版本在v1.28.8、v1.31.4及以上时支持使用镜像缓存功能。
       ![](https://support.huaweicloud.com/usermanual-cce-autopilot/public_sys-resources/note_3.0-zh-cn.png)
       目前，只有部分区域支持使用镜像缓存，具体请以控制台为准。
        表2镜像缓存参数说明 
       | 参数选项      | 示例              | 选项说明                                                                                                                                                                                                                                                                                                                         |
       |:---|:---|:---|
       | 不使用      | -                | 不使用镜像缓存，按照"容器信息"中的镜像内容重新下载镜像。                                                                                                                                                                                                                                                                                              |
       | 自动匹配镜像缓存 | -               | 从所有可用的镜像缓存中自动匹配最优镜像，并且匹配顺序如下： - 镜像匹配度：选择镜像信息匹配度最高的镜像缓存。  - 创建时间：选择创建时间最新的镜像缓存。   如果集群未匹配到镜像，则不再使用镜像缓存。 |
       | 指定镜像缓存  | autopilot-test | 指定已有的镜像缓存，该镜像缓存必须为可用状态。如果您需要新建镜像缓存请单击创建镜像缓存，参数说明请参见[创建镜像缓存](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0158.html)。                                                                                                                                                                                       |
          
       
     
     - 容器信息：Pod中可以配置多个容器，您可以单击右侧"添加容器"为Pod配置多个容器。
       - 基本信息：配置容器的基本信息。
         表3容器的基本信息 
         | 参数       | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
         |:---|:---|
         | 容器名称     | 为容器命名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
         | 更新策略     | 镜像更新/拉取策略。可以勾选"总是拉取镜像"，表示每次都从镜像仓库拉取镜像；如不勾选则优先使用本地已有的镜像，如果没有这个镜像再从镜像仓库拉取。 如果使用镜像缓存，建议不要勾选"总是拉取镜像"，避免重复从原镜像仓库拉取镜像。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
         | 镜像名称     | 单击后方"选择镜像"，选择容器使用的镜像。如果需要使用第三方镜像，请参见[使用第三方镜像](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0009.html)。 如果选择镜像缓存，您需要填入以下信息： - 如果您选择"自动匹配镜像缓存"：您可以在"容器信息 \> 基本信息 \> 镜像名称"中直接输入待使用的镜像名称，集群会按照[镜像缓存参数说明](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0047.html#cce_11_0047__table84021337125719)中的匹配顺序自动匹配。如果在镜像缓存中未匹配到镜像，则不再使用镜像缓存。不使用镜像缓存后，集群将在SWR镜像仓库、镜像中心依次匹配输入的镜像名称，若最终未匹配，则返回镜像拉取失败。  - 如果您选择"指定镜像缓存"：您需要在"容器信息 \> 基本信息 \> 镜像名称"中直接输入该镜像缓存中待使用的镜像的地址。 镜像地址获取方式：鼠标悬浮于指定的镜像缓存上，在出现的悬浮框中对应镜像的"镜像信息"即为镜像地址。    |
         | 镜像版本      | 选择需要部署的镜像版本。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
         | CPU配额     | CPU资源限制值，即允许容器使用的CPU最大值，防止占用过多资源。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
         | 内存配额      | 内存资源限制值，即允许容器使用的内存最大值。如果超过，容器会被终止。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
         | 初始化容器（可选） | 选择容器是否作为初始化（Init）容器。初始化（Init）容器不支持设置健康检查。 Init容器是一种特殊容器，可以在Pod中的其他应用容器启动之前运行。每个Pod中可以包含多个容器，同时Pod中也可以有一个或多个先于应用容器启动的Init容器，当所有的Init 容器运行完成时，Pod中的应用容器才会启动并运行。详细说明请参见[Init容器](https://kubernetes.io/zh/docs/concepts/workloads/pods/init-containers/)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
         | 容器启动项（可选）  | 为容器添加启动项参数，详情请参见[Pod参数](https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/workload-resources/pod-v1/)。CCE Autopilot集群支持以下启动项参数： - stdin：为容器开启标准输入，允许从外部源（如终端或其他输入流）接收输入。  - tty：为容器分配一个虚拟终端，允许您像在本地终端中一样向容器发送命令。 一般需要同时开启stdin，表示将终端（tty）绑定到容器的标准输入（stdin）上，可以支持类似于**kubectl exec -i -t**命令的交互式操作，但区别在于该参数在Pod启动时就已经配置完成。                                                                                                                                                                               |
            
         
       
       - 生命周期（可选）：在容器的生命周期的特定阶段配置需要执行的操作，例如启动命令、启动后处理和停止前处理，详情请参见[设置容器生命周期](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0105.html)。
       
       - 环境变量（可选）：支持通过键值对的形式为容器运行环境设置变量，可用于把外部信息传递给Pod中运行的容器，可以在应用部署后灵活修改，详情请参见[设置环境变量](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0113.html)。
       
       - 数据存储（可选）：在容器内挂载本地存储或云存储，不同类型的存储使用场景及挂载方式不同，详情请参见[存储](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0374.html)。
        
     
     - 镜像访问凭证：用于访问镜像仓库的凭证，默认取值为default-secret，使用default-secret可访问SWR镜像仓库的镜像。default-secret详细说明请参见[default-secret](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0388.html#cce_11_0388__section136587457392)。
     
     
     
     
  
  5. 填写**定时规则** 。
     
     
     | 参数  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
     |:---|:---|
     | 并发策略  | 支持如下三种模式。 - Forbid：在前一个任务未完成时，不创建新任务。  - Allow：定时任务不断新建Job，会抢占集群资源。  - Replace：已到新任务创建时间点，但前一个任务还未完成，新的任务会取代前一个任务。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
     | 定时规则  | 指定新建定时任务在何时执行，YAML中的定时规则通过CRON表达式实现。 - 以固定周期执行定时任务，支持的周期单位为分钟、小时、日、月。例如，每30分钟执行一次任务，对应的CRON表达式为"\*/30 \* \* \* \*"，执行时间将从单位范围内的0值开始计算，如**00:00:00** 、**00:30:00** 、**01:00:00** 、**...**。  - 以固定时间（按月）执行定时任务。例如，在每个月1日的0时0分执行任务，对应的CRON表达式为"0 0 1 \*/1 \*"，执行时间为**\*\*\*\*-01-01 00:00:00** 、**\*\*\*\*-02-01 00:00:00** 、**...**。  - 以固定时间（按周）执行定时任务。例如，在每周一的0时0分执行任务，对应的CRON表达式为"0 0 \* \* 1"，执行时间为**\*\*\*\*-\*\*-01 周一 00:00:00** 、**\*\*\*\*-\*\*-08 周一 00:00:00** 、**...**。  - 自定义CRON表达式：关于CRON表达式的用法，可参考[CRON](https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax)。   说明： - 以固定时间（按月）执行定时任务时，在某月的天数不存在的情况下，任务将不会在该月执行。例如设置天数为30，而2月份没有30号，任务将跳过该月份，在3月30号继续执行。  - 由于CRON表达式的定义，这里的固定周期并非严格意义的周期。将从0开始按周期对其时间单位范围（例如单位为分钟时，则范围为0\~59）进行划分，无法整除时最后一个周期会被重置。因此仅在周期能够平均划分其时间单位范围时，才能表示准确的周期。 举个例子，周期单位为小时，因为"/2、/3、/4、/6、/8和/12"可将24小时整除，所以可以表示准确的周期；而使用其他周期时，在新的一天开始时，最后一个周期将会被重置。比如CRON式为"\* \*/12 \* \* \*"时为准确的周期，每天的执行时间为**00:00:00** 和**12:00:00** ；而CRON式为"\* \*/13 \* \* \*"时，每天的执行时间为**00:00:00** 和**13:00:00**，在第二天0时，虽然没到13个小时的周期还是会被刷新。    |
     | 时区 | 可以指定定时规则应用的时区。如果未指定，将默认为控制节点所在的时区。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
     | 任务记录 | 可以设置保留执行成功或执行失败的任务个数，设置为0表示不保留。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
        
     
     
  
  6. （可选）填写工作负载关联的**高级配置** 。
     
     表4工作负载的高级配置 
     | 参数     | 说明                                                                                                                                                                                                                                                                                                                                               |
     |:---|:---|
     | 标签与注解 | 以键值对形式为工作负载Pod添加标签或注解，填写完成后需单击"确认添加"。关于标签与注解的作用及配置说明，请参见[设置标签与注解](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0386.html)。                                                                                                                                                                                      |
     | 网络配置 | - 是否开启指定容器网络配置：开启指定容器网络配置，工作负载使用指定的容器网络配置中的容器子网和安全组来创建，详情请参见[使用容器网络配置为命名空间/工作负载绑定子网及安全组](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0196.html)。  - 指定容器网络配置名：只支持选择关联资源类型为工作负载类型的自定义容器网络配置。   |
        
     
     
  
  7. 在"规格确认"中，请确认以下信息： 
     1. Pod资源规格计算规则：
        - 默认情况：Pod申请的整体资源规格，基于所有初始化容器与普通容器所需CPU/内存配额计算。
        
        - 自定义配置：若您已配置Pod级别的资源配额，则以Pod级别配置数值作为最终Pod资源规格（优先级高于容器级别配置）。
         
     
     2. 请确保"单Pod临时存储"能够满足容器的需要，具体请参见[增加Pod的临时存储容量](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0867.html)。
     
     3. 计费规格说明：
        - 单Pod的实际计费规格会基于Pod资源规格向上自动规整为Autopilot支持的规格档位，具体规格档位请查看[CCE Autopilot规格说明](https://support.huaweicloud.com/productdesc-cce-autopilot/cce_12_0002.html#section1)。
        
        - 当Pod申请的资源规格低于实际计费规格时，建议使用"一键补齐"功能补足规格差值，避免资源浪费。
         
     
     4. 信息确认无误后，请勾选"我已知晓上述计费规则"。
     
     
     
     
  
  8. 单击右下角"创建工作负载"，查看工作负载状态为"已启动"。 
     ![](https://support.huaweicloud.com/usermanual-cce-autopilot/zh-cn_image_0000002529255505.png "点击放大")
     
     
   
- [通过kubectl命令行创建]
  ![](https://support.huaweicloud.com/usermanual-cce-autopilot/public_sys-resources/notice_3.0-zh-cn.png)
  Autopilot集群暂不支持配置节点亲和与反亲和，所以当您使用kubectl命令行创建工作负载时，为避免Pod创建失败，请不要配置affinity字段。
  CronJob的配置参数如下所示：
  - .spec.schedule指定任务运行时间与周期，参数格式请参见[Cron](https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax)，例如"0 \* \* \* \* "或"@hourly"。
  
  - .spec.jobTemplate指定需要运行的任务，格式与[使用kubectl创建Job](https://support.huaweicloud.com/usermanual-cce-autopilot/cce_11_0150.html#cce_11_0150__zh-cn_topic_0000001199021206_section450152719412)相同。
  
  - .spec.startingDeadlineSeconds指定任务开始的截止期限。
  
  - .spec.concurrencyPolicy指定任务的并发策略，支持Allow、Forbid和Replace三个选项。
    - Allow（默认）：允许并发运行Job。
    
    - Forbid：禁止并发运行，如果前一个还没有完成，则直接跳过下一个。
    
    - Replace：取消当前正在运行的Job，用一个新的来替换。
     
  
  
  下面是一个CronJob的示例，保存在cronjob.yaml文件中。
  ![](https://support.huaweicloud.com/usermanual-cce-autopilot/public_sys-resources/note_3.0-zh-cn.png)
  在v1.21及以上集群中，CronJob的apiVersion为**batch/v1**。
  在v1.21以下集群中，CronJob的apiVersion为**batch/v1beta1**。
  ```
  apiVersion: batch/v1
  kind: CronJob
  metadata:
    name: hello
  spec:
    schedule: "*/1 * * * *"
    jobTemplate:
      spec:
        template:
          spec:
            containers:
            - name: hello
              image: busybox
              command:
              - /bin/sh
              - -c
              - date; echo Hello from the Kubernetes cluster
            restartPolicy: OnFailure
            imagePullSecrets:
              - name: default-secret
  ```
  **运行该任务，如下：**
  1. 创建CronJob。 
     **kubectl create -f cronjob.yaml**
     命令行终端显示如下信息：
     ```
     cronjob.batch/hello created
     ```
     
     
  
  2. 执行如下命令，查看执行情况。 
     **kubectl get cronjob**
     ```
     NAME      SCHEDULE      SUSPEND   ACTIVE    LAST SCHEDULE   AGE
     hello     */1 * * * *   False     0         <none>          9s
     ```
     **kubectl get jobs**
     ```
     NAME               COMPLETIONS   DURATION   AGE
     hello-1597387980   1/1           27s        45s
     ```
     **kubectl get pod**
     ```
     NAME                           READY     STATUS      RESTARTS   AGE
     hello-1597387980-tjv8f         0/1       Completed   0          114s
     hello-1597388040-lckg9         0/1       Completed   0          39s
     ```
     **kubectl logs** **hello-1597387980-tjv8f**
     ```
     Fri Aug 14 06:56:31 UTC 2020
     Hello from the Kubernetes cluster
     ```
     **kubectl delete cronjob hello**
     ```
     cronjob.batch "hello" deleted
     ```
     ![](https://support.huaweicloud.com/usermanual-cce-autopilot/public_sys-resources/notice_3.0-zh-cn.png)
     删除CronJob时，对应的普通任务及相关的Pod都会被删除。
     
     
   
#### 相关操作
定时任务创建完成后，您还可执行[表5]中操作。
 表5其他操作 
| 操作        | 操作说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|
| 编辑YAML                     | 单击定时任务名称后的"更多 \> 编辑YAML"，可修改当前任务对应的YAML文件。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 停止定时任务    | 1. 选择待停止的任务，单击操作列的"停止"。  2. 单击"是"。                                                                                                                                                                     |
| 删除定时任务 | 1. 选择待删除的任务，单击操作列的"更多 \> 删除"。  2. 单击"是"。 任务删除后将无法恢复，请谨慎操作。    |
   
