Kubernetes Job: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 10: Line 10:
A Kubernetes Job is a workload resource that can be used to start and manage Pods to successful completion.  
A Kubernetes Job is a workload resource that can be used to start and manage Pods to successful completion.  


A Pod is considered completed, and thus its execution counted against the completion counter only if finishes successfully. This counter can be configured with <code>[[Kubernetes_Job_Manifest#completions|.spec.completions]]</code>. When the specified number of successful completions is reached, the Job is complete. The Job will attempt to restart failed Pods, which don't count against successful executions. The number of retires until the attempts are dropped can be configured with <code>[[Kubernetes_Job_Manifest#backoffLimit|.spec.backoffLimit]]</code>. More details on a Job's life cycle is available in the [[#Job_Lifecycle|Job Lifecycle]] section.
A Pod is considered completed, and thus its execution counted against the completion counter only if finishes successfully. This counter can be configured with <code>[[Kubernetes_Job_Manifest#completions|.spec.completions]]</code>. When the specified number of successful completions is reached, the Job is complete. The Job will attempt to restart failed Pods, which don't count against successful executions. The number of retires until the attempts are dropped can be configured with <code>[[Kubernetes_Job_Manifest#backoffLimit|.spec.backoffLimit]]</code>. For example, to configure a Job to run a Pod once, and give up immediately if it fails, use:
<syntaxhighlight lang='yaml'>
kind: Job
spec:
  completions: 1
  backoffLimit: 0
  [...]
</syntaxhighligh>
 
More details on a Job's life cycle is available in the [[#Job_Lifecycle|Job Lifecycle]] section.


The Pods managed by a Job will carry a <code>job-name</code> labels with the name of the job, and also a <code>controller-uid</code> label.
The Pods managed by a Job will carry a <code>job-name</code> labels with the name of the job, and also a <code>controller-uid</code> label.

Revision as of 21:27, 14 July 2023

External

Internal

Overview

A Kubernetes Job is a workload resource that can be used to start and manage Pods to successful completion.

A Pod is considered completed, and thus its execution counted against the completion counter only if finishes successfully. This counter can be configured with .spec.completions. When the specified number of successful completions is reached, the Job is complete. The Job will attempt to restart failed Pods, which don't count against successful executions. The number of retires until the attempts are dropped can be configured with .spec.backoffLimit. For example, to configure a Job to run a Pod once, and give up immediately if it fails, use:

kind: Job
spec:
  completions: 1
  backoffLimit: 0
  [...]
</syntaxhighligh>

More details on a Job's life cycle is available in the [[#Job_Lifecycle|Job Lifecycle]] section.

The Pods managed by a Job will carry a <code>job-name</code> labels with the name of the job, and also a <code>controller-uid</code> label.

Pods can be executed in parallel. The [[#Parallel_Execution|Parallel Execution]] section provides more details on that.

If the Job needs to execute on a schedule, a [[Kubernetes_CronJob|CronJob]] is a better tool.

=<span id='Kubernetes_Job_Manifest'></span>Manifest=
{{Internal|Kubernetes Job Manifest|Job Manifest}}

=Job Lifecycle=
==Pod and Container Failures==
{{External|https://kubernetes.io/docs/concepts/workloads/controllers/job/#handling-pod-and-container-failures}}
==Completion==
{{External|https://kubernetes.io/docs/concepts/workloads/controllers/job/#completion-mode}}
==Suspending a Job==
{{External|https://kubernetes.io/docs/concepts/workloads/controllers/job/#suspending-a-job}}

==Termination and Cleanup==
{{External|https://kubernetes.io/docs/concepts/workloads/controllers/job/#job-termination-and-cleanup}}
===Clean up Finished Jobs Automatically===
{{External|https://kubernetes.io/docs/concepts/workloads/controllers/job/#clean-up-finished-jobs-automatically}}

Jobs that have finished, either "Complete" or "Failed" can be automatically be deleted by using the TTL mechanism provided by the [TTL Controller ]. Set the <code>.spec.ttlSecondsAfterFinished</code> field in the job manifest. If the field is set to 0, the Job will be eligible to be automatically deleted immediately after it finishes.

<syntaxhighlight lang='yaml'>
apiVersion: batch/v1
kind: Job
spec:
  ttlSecondsAfterFinished: 100
  ...

Parallel Execution

https://kubernetes.io/docs/concepts/workloads/controllers/job/#parallel-jobs

Job Alternatives

https://kubernetes.io/docs/concepts/workloads/controllers/job/#alternatives