CronJob
apiVersion: batch/v1
import "k8s.io/api/batch/v1"
CronJob
CronJob represents the configuration of a single cron job.
-
apiVersion: batch/v1
-
kind: CronJob
-
spec (
Specification of the desired behavior of a cron job, including the schedule. More info:
CronJobSpec
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 (
Standard object's metadata of the jobs created from this template. More info:
-
jobTemplate.spec (
Specification of the desired behavior of the job. More info:
-
-
schedule (string), required
-
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
CronJobStatus represents the current state of a cron job.
-
active ([]
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
CronJobList is a collection of cron jobs.
-
apiVersion: batch/v1
-
kind: CronJobList
-
items ([]
items is the list of CronJobs.
Operations
get read the specified CronJob
HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
Parameters
-
name (in path): string, required
name of the CronJob
-
namespace (in path): string, required
-
pretty (in query): string
Response
200 (
401: Unauthorized GET /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 (
401: Unauthorized GET /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 (
401: Unauthorized GET /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 (
401: Unauthorized POST /apis/batch/v1/namespaces/{namespace}/cronjobs namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
202 (
401: Unauthorized PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} name (in path): string, required name of the CronJob namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
401: Unauthorized PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status name (in path): string, required name of the CronJob namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
401: Unauthorized PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} name (in path): string, required name of the CronJob namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string force (in query): boolean pretty (in query): string 200 (
201 (
401: Unauthorized PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status name (in path): string, required name of the CronJob namespace (in path): string, required dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string force (in query): boolean pretty (in query): string 200 (
201 (
401: Unauthorized DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} name (in path): string, required name of the CronJob namespace (in path): string, required dryRun (in query): string gracePeriodSeconds (in query): integer pretty (in query): string propagationPolicy (in query): string 200 (
202 (
401: Unauthorized DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs namespace (in path): string, required 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 (
401: Unauthorizedget read status of the specified CronJobHTTP Request
Parameters
Response
list list or watch objects of kind CronJobHTTP Request
Parameters
Response
list list or watch objects of kind CronJobHTTP Request
Parameters
Response
create create a CronJobHTTP Request
Parameters
Response
update replace the specified CronJobHTTP Request
Parameters
Response
update replace status of the specified CronJobHTTP Request
Parameters
Response
patch partially update the specified CronJobHTTP Request
Parameters
Response
patch partially update status of the specified CronJobHTTP Request
Parameters
Response
delete delete a CronJobHTTP Request
Parameters
Response
deletecollection delete collection of CronJobHTTP Request
Parameters
Response