apiVersion: batch/v1
import "k8s.io/api/batch/v1"
CronJob represents the configuration of a single cron job.
apiVersion: batch/v1
kind: CronJob
metadata (ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (CronJobSpec)
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (CronJobStatus)
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
CronJobSpec describes how the job execution will look like and when it will actually run.
jobTemplate (JobTemplateSpec), required
Specifies the job that will be created when executing a CronJob.
JobTemplateSpec describes the data a Job should have when created from a template
jobTemplate.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
jobTemplate.spec (JobSpec)
Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
schedule (string), required
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
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.startingDeadlineSeconds (int64)
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.
suspend (boolean)
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
successfulJobsHistoryLimit (int32)
The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
failedJobsHistoryLimit (int32)
The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
CronJobStatus represents the current state of a cron job.
active ([]ObjectReference)
Atomic: will be replaced during a merge
A list of pointers to currently running jobs.
lastScheduleTime (Time)
Information when was the last time the job was successfully scheduled.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
lastSuccessfulTime (Time)
Information when was the last time the job successfully completed.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
CronJobList is a collection of cron jobs.
apiVersion: batch/v1
kind: CronJobList
metadata (ListMeta)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]CronJob), required
items is the list of CronJobs.
get
read the specified CronJobGET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
name (in path): string, required
name of the CronJob
namespace (in path): string, required
pretty (in query): string
200 (CronJob): OK
401: Unauthorized
get
read status of the specified CronJobGET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
name (in path): string, required
name of the CronJob
namespace (in path): string, required
pretty (in query): string
200 (CronJob): OK
401: Unauthorized
list
list or watch objects of kind CronJobGET /apis/batch/v1/namespaces/{namespace}/cronjobs
namespace (in path): string, required
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
200 (CronJobList): OK
401: Unauthorized
list
list or watch objects of kind CronJobGET /apis/batch/v1/cronjobs
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
200 (CronJobList): OK
401: Unauthorized
create
create a CronJobPOST /apis/batch/v1/namespaces/{namespace}/cronjobs
namespace (in path): string, required
body: CronJob, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (CronJob): OK
201 (CronJob): Created
202 (CronJob): Accepted
401: Unauthorized
update
replace the specified CronJobPUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
name (in path): string, required
name of the CronJob
namespace (in path): string, required
body: CronJob, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
update
replace status of the specified CronJobPUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
name (in path): string, required
name of the CronJob
namespace (in path): string, required
body: CronJob, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
patch
partially update the specified CronJobPATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
name (in path): string, required
name of the CronJob
namespace (in path): string, required
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
patch
partially update status of the specified CronJobPATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
name (in path): string, required
name of the CronJob
namespace (in path): string, required
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
delete
delete a CronJobDELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
name (in path): string, required
name of the CronJob
namespace (in path): string, required
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection
delete collection of CronJobDELETE /apis/batch/v1/namespaces/{namespace}/cronjobs
namespace (in path): string, required
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
200 (Status): OK
401: Unauthorized
© 2022 The Kubernetes Authors
Documentation Distributed under CC BY 4.0.
https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/cron-job-v1/