Fix up job create/cancel descriptions.
[arvados.git] / doc / api / methods / jobs.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: API Methods
5 title: "jobs"
6
7 ...
8
9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
10
11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
12
13 Required arguments are displayed in %{background:#ccffcc}green%.
14
15 h2. cancel
16
17 Cancel a job that is queued or running.
18
19 Arguments:
20
21 table(table table-bordered table-condensed).
22 |_. Argument |_. Type |_. Description |_. Location |_. Example |
23 {background:#ccffcc}.|uuid|string||path||
24
25 h2(#create). create
26
27 Create a new Job.
28
29 Arguments:
30
31 table(table table-bordered table-condensed).
32 |_. Argument |_. Type |_. Description |_. Location |_. Example |
33 {background:#ccffcc}.|job|object|See "Job resource":{{site.baseurl}}/schema/Job.html|request body||
34 |minimum_script_version |string     |Git branch, tag, or commit hash specifying the minimum acceptable script version (earliest ancestor) to consider when deciding whether to re-use a past job.|query|@c3e86c9@|
35 |exclude_script_versions|array of strings|Git commit branches, tags, or hashes to exclude when deciding whether to re-use a past job.|query|@["8f03c71","8f03c71"]@|
36 |find_or_create         |boolean    |Before creating, look for an existing job that has identical script, script_version, and script_parameters to those in the present job, has nondeterministic=false, and did not fail (it could be queued, running, or completed). If such a job exists, respond with the existing job instead of submitting a new one.|query|@false@|
37
38 When a job is submitted to the queue using the **create** method, the 'script_version' field is updated to a full 40-character Git commit hash based on the current content of the specified repository. If 'script_version' cannot be resolved, the job submission is rejected.
39
40 h3. Reusing jobs
41
42 Because Arvados records the exact version of the script, input parameters, and runtime environment [1] that was used to run the job, if the script is deterministic (meaning that the same code version is guaranteed to produce the same outputs from the same inputs) then it is possible to re-use the results of past jobs, and avoid re-running the computation to save time.  Arvados uses the following algorithm to determine if a past job can be re-used:
43
44 notextile. <div class="spaced-out">
45
46 # If 'find_or_create' is false or omitted, create a new job and skip the rest of these steps.
47 # Find a list of acceptable values for 'script_version'.  If 'minimum_script_version' is specified, this is the set of all revisions in the Git commit graph between 'minimum_script_version' and 'script_version' (inclusive) [2].  If 'minimum_script_version' is not specified, only 'script_version' is added to the list.  If 'exclude_script_versions' is specified, the listed versions are excluded from the list.
48 # Select jobs whose 'script' and 'script_parameters' attributes match the submitted job, and whose 'script_version' attribute is in the list of acceptable versions.  Exclude jobs that failed or set 'nondeterministic' to true.
49 # If more than one of candidate jobs has finished, check that all such jobs actually did produce the same output.
50 # If existing jobs exist and do not disagree with one another about the correct output, re-use one of the selected past jobs. If there is more than one match, which job will be returned is undefined.
51 # If an existing job could not be chosen this way, create a new job.
52
53 fn1. As of this writing, versioning the runtime environment is still under development.
54
55 fn2. This may include parallel branches if there is more than one path between 'minimum_script_version' and 'script_version' in the Git commit graph.  Use 'exclude_script_versions' to blacklist specific versions.
56
57 </div>
58
59 h3. Examples
60
61 Run the script "crunch_scripts/hash.py" in the repository "you" using the "master" commit.  Arvados should re-use a previous job if the script_version of the previous job is the same as the current "master" commit. This works irrespective of whether the previous job was submitted using the name "master", a different branch name or tag indicating the same commit, a SHA-1 commit hash, etc.
62
63 <notextile><pre>
64 {
65   "job": {
66     "script": "hash.py",
67     "repository": "<b>you</b>",
68     "script_version": "master",
69     "script_parameters": {
70       "input": "c1bad4b39ca5a924e481008009d94e32+210"
71     }
72   },
73   "find_or_create": true
74 }
75 </pre></notextile>
76
77 Run using exactly the version "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5". Arvados should re-use a previous job if the "script_version" of that job is also "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5".
78
79 <notextile><pre>
80 {
81   "job": {
82     "script": "hash.py",
83     "repository": "<b>you</b>",
84     "script_version": "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5",
85     "script_parameters": {
86       "input": "c1bad4b39ca5a924e481008009d94e32+210"
87     }
88   },
89   "find_or_create": true
90 }
91 </pre></notextile>
92
93 Arvados should re-use a previous job if the "script_version" of the previous job is between "earlier_version_tag" and the "master" commit (inclusive), but not the commit indicated by "blacklisted_version_tag". If there are no previous jobs matching these criteria, run the job using the "master" commit.
94
95 <notextile><pre>
96 {
97   "job": {
98     "script": "hash.py",
99     "repository": "<b>you</b>",
100     "script_version": "master",
101     "script_parameters": {
102       "input": "c1bad4b39ca5a924e481008009d94e32+210"
103     }
104   },
105   "minimum_script_version": "earlier_version_tag",
106   "exclude_script_versions": ["blacklisted_version_tag"],
107   "find_or_create": true
108 }
109 </pre></notextile>
110
111 Run the script "crunch_scripts/monte-carlo.py" in the repository "you" using the current "master" commit. Because it is marked as "nondeterministic", this job will not be considered as a suitable candidate for future job submissions that use the "find_or_create" feature.
112
113 <notextile><pre>
114 {
115   "job": {
116     "script": "monte-carlo.py",
117     "repository": "<b>you</b>",
118     "script_version": "master",
119     "nondeterministic": true,
120     "script_parameters": {
121       "input": "c1bad4b39ca5a924e481008009d94e32+210"
122     }
123   }
124 }
125 </pre></notextile>
126
127 h2. delete
128
129 Delete an existing Job.
130
131 Arguments:
132
133 table(table table-bordered table-condensed).
134 |_. Argument |_. Type |_. Description |_. Location |_. Example |
135 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
136
137 h2. get
138
139 Gets a Job's metadata by UUID.
140
141 Arguments:
142
143 table(table table-bordered table-condensed).
144 |_. Argument |_. Type |_. Description |_. Location |_. Example |
145 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
146
147 h2. list
148
149 List jobs.
150
151 Arguments:
152
153 table(table table-bordered table-condensed).
154 |_. Argument |_. Type |_. Description |_. Location |_. Example |
155 |limit|integer (default 100)|Maximum number of jobs to return.|query||
156 |order|string|Order in which to return matching jobs.|query||
157 |filters|array|Conditions for filtering jobs.|query||
158
159 h2. log_tail_follow
160
161 log_tail_follow jobs
162
163 Arguments:
164
165 table(table table-bordered table-condensed).
166 |_. Argument |_. Type |_. Description |_. Location |_. Example |
167 {background:#ccffcc}.|uuid|string||path||
168 |buffer_size|integer (default 8192)||query||
169
170 h2. queue
171
172 Get the current job queue.
173
174 Arguments:
175
176 table(table table-bordered table-condensed).
177 |_. Argument |_. Type |_. Description |_. Location |_. Example |
178 |order|string||query||
179 |filters|array||query||
180
181 This method is equivalent to the "list method":#list, except that the results are restricted to queued jobs (i.e., jobs that have not yet been started or cancelled) and order defaults to queue priority.
182
183 h2. update
184
185 Update attributes of an existing Job.
186
187 Arguments:
188
189 table(table table-bordered table-condensed).
190 |_. Argument |_. Type |_. Description |_. Location |_. Example |
191 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
192 |job|object||query||