Job

apiVersion: batch/v1

Job represents the configuration of a single job.

• apiVersion: batch/v1

• kind: Job

• metadata ()

  Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• spec ()

  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 ()

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

JobSpec describes how the job execution will look like.

• template (), 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:

Lifecycle

• completionMode (string)

  CompletionMode specifies how Pod completions are tracked. It can be NonIndexed (default) or Indexed.

  NonIndexed means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.

  Indexed means 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 is Indexed, .spec.completions must be specified and .spec.parallelism must 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).

  More completion modes can be added in the future. If the Job controller observes a mode that it doesn’t recognize, which is possible during upgrades due to version skew, 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.

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

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

Alpha level

• podFailurePolicy (PodFailurePolicy)

  Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs’s .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure.

  This field is alpha-level. To use this field, you must enable the feature gate (disabled by default).

  PodFailurePolicy describes how failed pods influence the backoffLimit.

  • podFailurePolicy.rules ([]PodFailurePolicyRule), required

    Atomic: will be replaced during a merge

    A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.

    PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of OnExitCodes and onPodConditions, but not both, can be used in each rule.

    • podFailurePolicy.rules.action (string), required

      Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are: - FailJob: indicates that the pod’s job is marked as Failed and all running pods are terminated.

      • Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created.
      • Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.

    • podFailurePolicy.rules.onPodConditions ([]PodFailurePolicyOnPodConditionsPattern), required

      Atomic: will be replaced during a merge

      Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.

      PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.

      • podFailurePolicy.rules.onPodConditions.status (string), required

        Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.

      • podFailurePolicy.rules.onPodConditions.type (string), required

        Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.

    • podFailurePolicy.rules.onExitCodes (PodFailurePolicyOnExitCodesRequirement)

      Represents the requirement on the container exit codes.

      PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.

      • podFailurePolicy.rules.onExitCodes.operator (string), required

        Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is in the set of specified values.

        • NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.

      • podFailurePolicy.rules.onExitCodes.values ([]int32), required

        Set: unique values will be kept during a merge

        Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value ‘0’ cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.

      • podFailurePolicy.rules.onExitCodes.containerName (string)

        Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.

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 pending and 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 type

  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.

  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.

  • Set: unique values will be kept during a merge

    Succeeded holds UIDs of succeeded Pods.

Beta level

• ready (int32)

  The number of pods which have a Ready condition.

  This field is beta-level. The job controller populates the field when the feature gate JobReadyPods is enabled (enabled by default).

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.

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

• pretty (in query): 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 (in path): string, required

  name of the Job

• namespace (in path): string, required

  namespace

• 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

  allowWatchBookmarks

• continue (in query): string

• fieldSelector (in query): string

  fieldSelector

• labelSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

• timeoutSeconds (in query): integer

  timeoutSeconds

• 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

  continue

• fieldSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

• timeoutSeconds (in query): integer

  timeoutSeconds

• 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

  fieldManager

• fieldValidation (in query): string

• pretty (in query): string

  pretty

Response

200 (Job): OK

201 (): Created

202 (Job): 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

  namespace

• body: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• fieldValidation (in query): string

• pretty (in query): string

  pretty

Response

200 (Job): OK

201 (): 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

• body: Job, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

• pretty (in query): string

  pretty

Response

200 (Job): OK

201 (): 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: Patch, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

• force (in query): boolean

  force

• 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

  namespace

• body: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• fieldValidation (in query): string

  fieldValidation

• force (in query): boolean

• pretty (in query): string

  pretty

Response

200 (Job): OK

201 (): Created

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

• body: DeleteOptions

• dryRun (in query): string

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• pretty (in query): string

• propagationPolicy (in query): string

  propagationPolicy

Response

200 (Status): OK

202 (): Accepted

401: Unauthorized

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

  dryRun

• fieldSelector (in query): string

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• labelSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• propagationPolicy (in query): string

  propagationPolicy

• resourceVersion (in query): string

• resourceVersionMatch (in query): string

  resourceVersionMatch

Response

200 (Status): OK

401: Unauthorized