website/job-v1.md at 04c41cb89fe0f3460a07035675a032dab567d545

20 KiB

Raw Blame History

api_metadata

content_type

description

title

weight

apiVersion	import	kind
batch/v1	k8s.io/api/batch/v1	Job

api_reference

Job represents the configuration of a single job.

Job

apiVersion: batch/v1

import "k8s.io/api/batch/v1"

Job

Job represents the configuration of a single job.

apiVersion: batch/v1
kind: Job
metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (<a href="{{< ref "../workloads-resources/job-v1#JobSpec" >}}">JobSpec)

Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (<a href="{{< ref "../workloads-resources/job-v1#JobStatus" >}}">JobStatus)

Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

JobSpec

JobSpec describes how the job execution will look like.

Replicas

template (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec), required

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
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/
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 active before the system tries to terminate it; value must be positive integer
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.

Selector

selector (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">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
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

JobStatus

JobStatus represents the current state of a Job.

startTime (Time)

Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. 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.
conditions ([]JobCondition)

Patch strategy: merge on key type

The latest available observations of an object's current state. When a job fails, one of the conditions will have type == "Failed". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

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.

JobList

JobList is a collection of jobs.

apiVersion: batch/v1
kind: JobList
metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job), required

items is the list of Jobs.

Operations

`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
namespace (in path): string, required

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

401: Unauthorized

`get` read status of the specified Job

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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): 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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
allowWatchBookmarks (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
continue (in query): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
fieldSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
labelSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
resourceVersion (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
watch (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#JobList" >}}">JobList): OK

401: Unauthorized

`list` list or watch objects of kind Job

HTTP Request

GET /apis/batch/v1/jobs

Parameters

allowWatchBookmarks (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
continue (in query): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
fieldSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
labelSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
resourceVersion (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
watch (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#JobList" >}}">JobList): OK

401: Unauthorized

`create` create a Job

HTTP Request

POST /apis/batch/v1/namespaces/{namespace}/jobs

Parameters

namespace (in path): string, required

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job, required
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): Created

202 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): Accepted

401: Unauthorized

`update` replace the specified Job

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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job, required
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): Created

401: Unauthorized

`update` replace status of the specified Job

HTTP Request

PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

Parameters

name (in path): string, required

name of the Job
namespace (in path): string, required

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job, required
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
force (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
force (in query): boolean

<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job): OK

401: Unauthorized

`delete` delete a Job

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

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
gracePeriodSeconds (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy (in query): string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

Response

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized

`deletecollection` delete collection of Job

HTTP Request

DELETE /apis/batch/v1/namespaces/{namespace}/jobs

Parameters

namespace (in path): string, required

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
continue (in query): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
dryRun (in query): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
gracePeriodSeconds (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
labelSelector (in query): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (in query): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy (in query): string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
resourceVersion (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (in query): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (in query): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

Response

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

401: Unauthorized

20 KiB Raw Blame History

Job

JobSpec

Replicas

Lifecycle

Selector

JobStatus

JobList

Operations

get read the specified Job

HTTP Request

Parameters

Response

get read status of the specified Job

HTTP Request

Parameters

Response

list list or watch objects of kind Job

HTTP Request

Parameters

Response

list list or watch objects of kind Job

HTTP Request

Parameters

Response

create create a Job

HTTP Request

Parameters

Response

update replace the specified Job

HTTP Request

Parameters

Response

update replace status of the specified Job

HTTP Request

Parameters

Response

patch partially update the specified Job

HTTP Request

Parameters

Response

patch partially update status of the specified Job

HTTP Request

Parameters

Response

delete delete a Job

HTTP Request

Parameters

Response

deletecollection delete collection of Job

HTTP Request

Parameters

Response

20 KiB

Raw Blame History

`get` read the specified Job

`get` read status of the specified Job

`list` list or watch objects of kind Job

`list` list or watch objects of kind Job

`create` create a Job

`update` replace the specified Job

`update` replace status of the specified Job

`patch` partially update the specified Job

`patch` partially update status of the specified Job

`delete` delete a Job

`deletecollection` delete collection of Job