我的书签
添加书签
移除书签Job
apiVersion: batch/v1
Job represents the configuration of a single job.
apiVersion: batch/v1
kind: Job
spec (JobSpec)
Specification of the desired behavior of a job. More info:
status (JobStatus)
Current status of a job. More info:
JobSpec describes how the job execution will look like.
template (PodTemplateSpec), required
Describes the pod that will be created when executing a job. More info:
parallelism (int32)
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/
Lifecycle
completions (int32)
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/
completionMode (string)
CompletionMode specifies how Pod completions are tracked. It can be
NonIndexed(default) orIndexed.NonIndexedmeans that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.Indexedmeans 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 isIndexed, .spec.completions must be specified and.spec.parallelismmust 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).This field is beta-level. More completion modes can be added in the future. If the Job controller observes a mode that it doesn’t recognize, the controller skips updates for the Job.
backoffLimit (int32)
Specifies the number of retries before marking this job failed. Defaults to 6
activeDeadlineSeconds (int64)
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.
ttlSecondsAfterFinished (int32)
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. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
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.
This field is beta-level, gated by SuspendJob feature flag (enabled by default).
Selector
selector (LabelSelector)
A label query over pods that should match the pod count. Normally, the system sets this field for you. More info:
manualSelector (boolean)
manualSelector controls generation of pod labels and pod selectors. Leave
manualSelectorunset 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 seemanualSelector=truein jobs that were created with the oldextensions/v1beta1API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
JobStatus represents the current state of a Job.
startTime (Time)
Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
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.
completionTime (Time)
Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully.
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.
active (int32)
The number of actively running pods.
failed (int32)
The number of pods which reached phase Failed.
succeeded (int32)
The number of pods which reached phase Succeeded.
completedIndexes (string)
CompletedIndexes holds the completed indexes when .spec.completionMode = “Indexed” in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as “1,3-5,7”.
conditions ([]JobCondition)
Patch strategy: merge on key
Atomic: will be replaced during a merge
The latest available observations of an object’s current state. When a Job fails, one of the conditions will have type “Failed” and status true. When a Job is suspended, one of the conditions will have type “Suspended” and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type “Complete” and status true. More info:
JobCondition describes current state of a job.
conditions.status (string), required
Status of the condition, one of True, False, Unknown.
conditions.type (string), required
Type of job condition, Complete or Failed.
conditions.lastProbeTime (Time)
Last time the condition was checked.
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.
conditions.lastTransitionTime (Time)
Last time the condition transit from one status to another.
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.
conditions.message (string)
Human readable message indicating details about last transition.
conditions.reason (string)
(brief) reason for the condition’s last transition.
uncountedTerminatedPods (UncountedTerminatedPods)
UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn’t yet accounted for in the status counters.
The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status: (1) Add the pod UID to the arrays in this field. (2) Remove the pod finalizer. (3) Remove the pod UID from the arrays while increasing the corresponding counter.
This field is alpha-level. The job controller only makes use of this field when the feature gate PodTrackingWithFinalizers is enabled. Old jobs might not be tracked using this field, in which case the field remains null.
UncountedTerminatedPods holds UIDs of Pods that have terminated but haven’t been accounted in Job status counters.
uncountedTerminatedPods.failed ([]string)
Set: unique values will be kept during a merge
Failed holds UIDs of failed Pods.
uncountedTerminatedPods.succeeded ([]string)
Set: unique values will be kept during a merge
Succeeded holds UIDs of succeeded Pods.
JobList is a collection of jobs.
apiVersion: batch/v1
kind: JobList
metadata (ListMeta)
Standard list metadata. More info:
items ([]Job), required
items is the list of Jobs.
get read the specified Job
HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameters
name (in path): string, required
name of the Job
pretty (in query): string
Response
200 (): OK
401: Unauthorized
HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
pretty (in query): string
Response
200 (): OK
401: Unauthorized
list list or watch objects of kind Job
HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs
Parameters
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
Response
200 (): OK
401: Unauthorized
list list or watch objects of kind Job
HTTP Request
GET /apis/batch/v1/jobs
Parameters
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (): OK
401: Unauthorized
create create a Job
HTTP Request
POST /apis/batch/v1/namespaces/{namespace}/jobs
Parameters
namespace (in path): string, required
body: Job, required
dryRun (in query): string
fieldManager (in query): string
pretty (in query): string
Response
200 (): OK
201 (Job): Created
202 (): Accepted
401: Unauthorized
HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
body: , required
dryRun (in query): string
fieldManager (in query): string
pretty (in query): string
Response
200 (Job): OK
201 (): Created
401: Unauthorized
update replace status of the specified Job
HTTP Request
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
body: Job, required
dryRun (in query): string
fieldManager (in query): string
pretty (in query): string
Response
200 (): OK
201 (Job): Created
401: Unauthorized
patch partially update the specified Job
HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
body: , required
dryRun (in query): string
fieldManager (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (): OK
201 (Job): Created
401: Unauthorized
patch partially update status of the specified Job
HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
body: , required
dryRun (in query): string
fieldManager (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (): OK
201 (Job): Created
401: Unauthorized
HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameters
name (in path): string, required
name of the Job
namespace (in path): string, required
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
Response
200 (Status): OK
202 (): Accepted
401: Unauthorized
deletecollection delete collection of Job
HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/jobs
Parameters
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
Response
401: Unauthorized
