Create CronJob¶

This page introduces how to create a CronJob through images and YAML files.

CronJobs are suitable for performing periodic operations, such as backup and report generation. These jobs can be configured to repeat periodically (for example: daily/weekly/monthly), and the time interval at which the job starts to run can be defined.

Prerequisites¶

Before creating a CronJob, the following prerequisites need to be met:

• You have integrated a Kubernetes Cluster in the Container Management module as described in Integrate Kubernetes Cluster or Create Kubernetes Cluster, and you can access the cluster's UI interface.

• Create a namespace and a user.

• The current operating user should have NS Editor or higher permissions, for details, refer to Namespace Authorization.

• When there are multiple containers in a single instance, make sure that the ports used by the containers do not conflict, otherwise the CronJob will fail.

Create by image¶

Refer to the following steps to create a CronJob using the image.

1. Click Clusters on the left navigation bar, and then click the name of the target cluster to enter the cluster details page.

   

2. On the cluster details page, click Workloads -> CronJobs in the left navigation bar, and then click the Create by Image button in the upper right corner of the page.

   

3. Fill in Basic Information, Container Settings, CronJob Settings, Advanced Configuration, click OK in the lower right corner of the page to complete the creation.

   The system will automatically return to the CronJobs list. Click ┇ on the right side of the list to perform operations such as updating, deleting, and restarting the CronJob.

   

Basic information¶

On the Create CronJobs page, enter the information according to the table below, and click Next .

• Workload Name: Can contain up to 63 characters, can only contain lowercase letters, numbers, and a separator ("-"), and must start and end with a lowercase letter or number. The name of the same type of workload in the same namespace cannot be repeated, and the name of the workload cannot be changed after the workload is created.
• Namespace: Select which namespace to deploy the newly created CronJob in, and the default namespace is used by default. If you can't find the desired namespace, you can go to Create a new namespace according to the prompt on the page.
• Description: Enter the description information of the workload and customize the content. The number of characters should not exceed 512.

Container settings¶

Container setting is divided into six parts: basic information, life cycle, health check, environment variables, data storage, and security settings. Click the tab below to view the requirements of each part.

Container setting is only configured for a single container. To add multiple containers to a pod, click + on the right to add multiple containers.

CronJob Settings¶

• Concurrency Policy: Whether to allow multiple Job jobs to run in parallel.

  • Allow : A new CronJob can be created before the previous job is completed, and multiple jobs can be parallelized. Too many jobs may occupy cluster resources.
  • Forbid : Before the previous job is completed, a new job cannot be created. If the execution time of the new job is up and the previous job has not been completed, CronJob will ignore the execution of the new job.
  • Replace : If the execution time of the new job is up, but the previous job has not been completed, the new job will replace the previous job.

  The above rules only apply to multiple jobs created by the same CronJob. Multiple jobs created by multiple CronJobs are always allowed to run concurrently.

• Policy Settings: Set the time period for job execution based on minutes, hours, days, weeks, and months. Support custom Cron expressions with numbers and * , after inputting the expression, the meaning of the current expression will be prompted. For detailed expression syntax rules, refer to Cron Schedule Syntax.

• Job Records: Set how many records of successful or failed jobs to keep. 0 means do not keep.
• Timeout: When this time is exceeded, the job will be marked as failed to execute, and all Pods under the job will be deleted. When it is empty, it means that no timeout is set. The default is 360 s.
• Retries: the number of times the job can be retried, the default value is 6.
• Restart Policy: Set whether to restart the Pod when the job fails.

Service settings¶

Configure Service for the statefulset, so that the statefulset can be accessed externally.

1. Click the Create Service button.

   

2. Refer to Create Service to configure service parameters.

   

3. Click OK and click Next .

Advanced configuration¶

The advanced configuration of CronJobs mainly involves labels and annotations.

You can click the Add button to add labels and annotations to the workload instance Pod.

Create from YAML¶

In addition to mirroring, you can also create timed jobs more quickly through YAML files.

1. Click Clusters on the left navigation bar, and then click the name of the target cluster to enter the cluster details page.

   

2. On the cluster details page, click Workloads -> CronJobs in the left navigation bar, and then click the Create from YAML button in the upper right corner of the page.

   

3. Enter or paste the YAML file prepared in advance, click OK to complete the creation.

   

apiVersion: batch/v1
kind: CronJob
metadata:
  creationTimestamp: '2022-12-26T09:45:47Z'
  generation: 1
  name: demo
  namespace: default
  resourceVersion: '92726617'
  uid: d030d8d7-a405-4dcd-b09a-176942ef36c9
spec:
  concurrencyPolicy: Allow
  failedJobsHistoryLimit: 1
  jobTemplate:
    metadata:
      creationTimestamp: null
    spec:
      activeDeadlineSeconds: 360
      backoffLimit: 6
      template:
        metadata:
          creationTimestamp: null
        spec:
          containers:
            - image: nginx
              imagePullPolicy: IfNotPresent
              lifecycle: {}
              name: container-3
              resources:
                limits:
                  cpu: 250m
                  memory: 512Mi
                requests:
                  cpu: 250m
                  memory: 512Mi
              securityContext:
                privileged: false
              terminationMessagePath: /dev/termination-log
              terminationMessagePolicy: File
          dnsPolicy: ClusterFirst
          restartPolicy: Never
          schedulerName: default-scheduler
          securityContext: {}
          terminationGracePeriodSeconds: 30
  schedule: 0 0 13 * 5
  successfulJobsHistoryLimit: 3
  suspend: false
status: {}