Merge pull request #339 from kubernetes/erictune-patch-2

Document Deleting Jobs and Job Timeouts
2016-04-13 13:34:50 -07:00
parent adfe8da93d 40bab01676
commit 8e86f8081e
1 changed files with 39 additions and 0 deletions
@@ -181,6 +181,45 @@ sometimes be started twice.
 If you do specify `.spec.parallelism` and `.spec.completions` both greater than 1, then there may be
 multiple pods running at once.  Therefore, your pods must also be tolerant of concurrency.
 ## Job Termination and Cleanup
 When a Job completes, no more Pods are created, but the Pods are not deleted either.  Since they are terminated,
 they don't show up with `kubectl get pods`, but they will show up with `kubectl get pods -a`.  Keeping them around
 allows you to still view the logs of completed pods to check for errors, warnings, or other diagnostic output.
 The job object also remains after it is completed so that you can view its status.  It is up to the user to delete
 old jobs after noting their status.  Delete the job with `kubectl` (e.g. `kubectl delete jobs/pi` or `kubectl delete -f ./job.yaml`).  When you delete the job using `kubectl`, all the pods it created are deleted too.
 If a Job's pods are failing repeatedly, the Job will keep creating new pods forever, by default.
 Retrying forever can be a useful pattern.  If an external dependency of the Job's 
 pods is missing (for example an input file on a networked storage volume is not present), then the
 Job will keep trying Pods, and when you later resolve the external dependency (for example, creating
 the missing file) the Job will then complete without any further action.
 However, if you prefer not to retry forever, you can set a deadline on the job.  Do this by setting the
 `spec.activeDeadlineSeconds` field of the job to a number of seconds.  The job will have status with
 `reason: DeadlineExceeded`.  No more pods will be created, and existing pods will be deleted.
 ```yaml
 apiVersion: batch/v1
 kind: Job
 metadata:
  name: pi-with-timeout
 spec:
  activeDeadlineSeconds: 100
  template:
    metadata:
      name: pi
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
      restartPolicy: Never
 ```
 Note that both the Job Spec and the Pod Template Spec within the Job have a field with the same name.
 Set the one on the Job.
 ## Job Patterns
 The Job object can be used to support reliable parallel execution of Pods.  The Job object is not