×

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

CronJobSpec describes how the job execution will look like and when it will actually run.

status

object

CronJobStatus represents the current state of a cron job.

.spec

Description

CronJobSpec describes how the job execution will look like and when it will actually run.

Type

object

Required
  • schedule

  • jobTemplate

Property Type Description

concurrencyPolicy

string

Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - "Replace": cancels currently running job and replaces it with a new one

Possible enum values: - "Allow" allows CronJobs to run concurrently. - "Forbid" forbids concurrent runs, skipping next run if previous hasn’t finished yet. - "Replace" cancels currently running job and replaces it with a new one.

failedJobsHistoryLimit

integer

The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

jobTemplate

object

JobTemplateSpec describes the data a Job should have when created from a template

schedule

string

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

startingDeadlineSeconds

integer

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

successfulJobsHistoryLimit

integer

The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

suspend

boolean

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

timeZone

string

The time zone for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will rely on the time zone of the kube-controller-manager process. ALPHA: This field is in alpha and must be enabled via the CronJobTimeZone feature gate.

.spec.jobTemplate

Description

JobTemplateSpec describes the data a Job should have when created from a template

Type

object

Property Type Description

metadata

ObjectMeta

Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

JobSpec describes how the job execution will look like.

.spec.jobTemplate.spec

Description

JobSpec describes how the job execution will look like.

Type

object

Required
  • template

Property Type Description

activeDeadlineSeconds

integer

Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

backoffLimit

integer

Specifies the number of retries before marking this job failed. Defaults to 6

completionMode

string

CompletionMode specifies how Pod completions are tracked. It can be NonIndexed (default) or Indexed.

NonIndexed means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.

Indexed means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is Indexed, .spec.completions must be specified and .spec.parallelism must be less than or equal to 10^5. In addition, The Pod name takes the form $(job-name)-$(index)-$(random-string), the Pod hostname takes the form $(job-name)-$(index).

More completion modes can be added in the future. If the Job controller observes a mode that it doesn’t recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

completions

integer

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

manualSelector

boolean

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

parallelism

integer

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

selector

LabelSelector

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

suspend

boolean

Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.

template

PodTemplateSpec

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

ttlSecondsAfterFinished

integer

ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won’t be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

.status

Description

CronJobStatus represents the current state of a cron job.

Type

object

Property Type Description

active

array (ObjectReference)

A list of pointers to currently running jobs.

lastScheduleTime

Time

Information when was the last time the job was successfully scheduled.

lastSuccessfulTime

Time

Information when was the last time the job successfully completed.

API endpoints

The following API endpoints are available:

  • /apis/batch/v1/cronjobs

    • GET: list or watch objects of kind CronJob

  • /apis/batch/v1/watch/cronjobs

    • GET: watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/batch/v1/namespaces/{namespace}/cronjobs

    • DELETE: delete collection of CronJob

    • GET: list or watch objects of kind CronJob

    • POST: create a CronJob

  • /apis/batch/v1/watch/namespaces/{namespace}/cronjobs

    • GET: watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

    • DELETE: delete a CronJob

    • GET: read the specified CronJob

    • PATCH: partially update the specified CronJob

    • PUT: replace the specified CronJob

  • /apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}

    • GET: watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

  • /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

    • GET: read status of the specified CronJob

    • PATCH: partially update status of the specified CronJob

    • PUT: replace status of the specified CronJob

/apis/batch/v1/cronjobs

Table 1. Global query parameters
Parameter Type