Kubernetes Reference
Job

Job

Job

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

Job

Job represents the configuration of a single job.

JobSpec

JobSpec describes how the job execution will look like.

Replicas

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

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.
    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. 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.

Operations

get read the specified Job

HTTP Request

GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Parameters
  • {name} (string), required
    name of the Job
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (Job): OK
401: Unauthorized

get read status of the specified Job

HTTP Request

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

Parameters
  • {name} (string), required
    name of the Job
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (Job): OK
401: Unauthorized

list list or watch objects of kind Job

HTTP Request

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

Parameters
Response

200 (JobList): OK
401: Unauthorized

list list or watch objects of kind Job

HTTP Request

GET /apis/batch/v1/jobs

Parameters
Response

200 (JobList): OK
401: Unauthorized

create create a Job

HTTP Request

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

Parameters
Response

200 (Job): OK
201 (Job): Created
202 (Job): Accepted
401: Unauthorized

update replace the specified Job

HTTP Request

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

Parameters

  • {name} (string), required
    name of the Job

  • {namespace} (string), required
    namespace

  • body (Job), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?pretty (string)
    pretty

Response

200 (Job): OK
201 (Job): Created
401: Unauthorized

update replace status of the specified Job

HTTP Request

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

Parameters

  • {name} (string), required
    name of the Job

  • {namespace} (string), required
    namespace

  • body (Job), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?pretty (string)
    pretty

Response

200 (Job): OK
201 (Job): Created
401: Unauthorized

patch partially update the specified Job

HTTP Request

PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}

Parameters
Response

200 (Job): OK
401: Unauthorized

patch partially update status of the specified Job

HTTP Request

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

Parameters
Response

200 (Job): OK
401: Unauthorized

delete delete a Job

HTTP Request

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

Parameters
Response

200 (Status): OK
202 (Status): Accepted
401: Unauthorized

deletecollection delete collection of Job

HTTP Request

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

Parameters
Response

200 (Status): OK
401: Unauthorized

What's on this Page