Project

General

Profile

Containers API » History » Version 32

Tom Clegg, 05/09/2016 02:01 PM

1 9 Tom Clegg
{{>TOC}}
2
3 16 Tom Clegg
h1. Containers API (DRAFT)
4 1 Tom Clegg
5 22 Peter Amstutz
See also [[Crunch2_dispatch]]
6
7 16 Tom Clegg
A Container resource is a record of a computational process.
8 1 Tom Clegg
* Its goal is to capture, unambiguously, as much information as possible about the environment in which the process was run. For example, git trees, data collections, and docker images are stored as content addresses. This makes it possible to reason about the difference between two processes, and to replay a process at a different time and place.
9 16 Tom Clegg
* Clients can read Container records, but only the system can create or modify them.
10 1 Tom Clegg
11 16 Tom Clegg
*Note about the term "containers" vs. "jobs" and "services":* Here, we focus on the use of containers as producers of output data. We anticipate extending the feature set to cover service containers as well. The distinguishing feature of a service container is that _having it running_ is inherently valuable because of the way it interacts with the outside world.
12 1 Tom Clegg
13 16 Tom Clegg
A ContainerRequest is a client's expression of interest in knowing the outcome of a computational process.
14
* Typically, in this context the client's description of the process is less precise than a Container: a ContainerRequest describes container _constraints_ which can have different interpretations over time. For example, a ContainerRequest with a @{"kind":"git_tree","commit_range":"abc123..master",...}@ mount might be satisfiable by any of several different source trees, and this set of satisfying source trees can change when the repository's "master" branch is updated.
15
* The system is responsible for finding suitable Containers and assigning them to ContainerRequests. (Currently this is expected to be done synchronously during the containerRequests.create and containerRequests.update transactions.)
16
* A ContainerRequest may indicate that it can _only_ be satisfied by a new Container record (i.e., existing results should not be reused). In this case creating a ContainerRequest amounts to a submission to the container queue. This is appropriate when the purpose of the ContainerRequest is to test whether a process is repeatable.
17
* A ContainerRequest may indicate that it _cannot_ be satisfied by a new Container record. This is an appropriate way to test whether a result is already available.
18 1 Tom Clegg
19 16 Tom Clegg
When the system has assigned a Container to a ContainerRequest, anyone with permission to read the ContainerRequest also has permission to read the Container.
20
21 1 Tom Clegg
h2. Use cases
22
23
h3. Preview
24
25 16 Tom Clegg
Tell me how you would satisfy container request X. Which pdh/commits would be used? Is the satisfying container already started? finished?
26 9 Tom Clegg
27 16 Tom Clegg
h3. Submit a previewed existing container
28 1 Tom Clegg
29 16 Tom Clegg
I'm happy with the already-running/finished container you showed me in "preview". Give me access to that container, its logs, and [when it finishes] its output.
30 1 Tom Clegg
31 16 Tom Clegg
h3. Submit a previewed new container
32 9 Tom Clegg
33 16 Tom Clegg
I'm happy with the new container the "preview" response proposed to run. Run that container.
34 9 Tom Clegg
35 16 Tom Clegg
h3. Submit a new container (disable reuse)
36 9 Tom Clegg
37 16 Tom Clegg
I don't want to use an already-running/finished container. Run a new container that satisfies my container request.
38 9 Tom Clegg
39 16 Tom Clegg
h3. Submit a new duplicate container (disable reuse)
40 9 Tom Clegg
41 16 Tom Clegg
I'm happy with the already-running/finished container you showed me in "preview". Run a new container exactly like that one.
42 9 Tom Clegg
43 16 Tom Clegg
h3. Select a container and associate it with my ContainerRequest
44 9 Tom Clegg
45 16 Tom Clegg
I'm not happy with the container you chose, but I know of another container that satisfies my request. Assuming I'm right about that, attach my ContainerRequest to the existing container of my choice.
46 1 Tom Clegg
47 9 Tom Clegg
h3. Just do the right thing without a preview
48
49 16 Tom Clegg
Satisfy container request X one way or another, and tell me the resulting container's UUID.
50 6 Tom Clegg
51 16 Tom Clegg
h2. ContainerRequest/Container life cycle
52 6 Tom Clegg
53 16 Tom Clegg
Illustrating container re-use and preview facility:
54
# Client ClientA creates a ContainerRequest CRA with priority=0.
55
# Server creates container CX and assigns CX to CRA, but does not try to run CX yet because max(priority)=0.
56
# Client ClientA presents CX to the user. "We haven't computed this result yet, so we'll have to run a new container. Is this OK?"
57
# Client ClientB creates a ContainerRequest CRB with priority=1.
58
# Server assigns CX to CRB and puts CX in the execution queue with priority=1.
59
# Client ClientA updates CRA with priority=2.
60
# Server updates CX with priority=2.
61
# Container CX starts.
62
# Client ClientA updates CRA with priority=0. (This is as close as we get to a "cancel" operation.)
63
# Server updates CX with priority=1. (CRB still wants this container to complete.)
64
# Container CX finishes.
65
# Clients ClientA and ClientB have permission to read CX (ever since CX was assigned to their respective ContainerRequests) as well as its progress indicators, output, and log.
66 1 Tom Clegg
67 16 Tom Clegg
h2. "ContainerRequest" schema
68 1 Tom Clegg
69 6 Tom Clegg
|Attribute|Type|Description|Discussion|Examples|
70
|uuid, owner_uuid, modified_by_client_uuid,  modified_by_user_uuid|string|Usual Arvados model attributes|||
71
|
72
|created_at, modified_at|datetime|Usual Arvados model attributes|||
73 1 Tom Clegg
|
74
|name|string|Unparsed|||
75
|
76 6 Tom Clegg
|description|text|Unparsed|||
77 15 Tom Clegg
|
78 16 Tom Clegg
|properties|object|Client-defined structured data that does not affect how the container is run.|||
79 11 Tom Clegg
|
80 17 Tom Clegg
|state|string|Once a request is committed, the only attributes that can be modified are priority, container_uuid, and container_count_max. A request with @state="Final"@ cannot be modified.||@"Uncommitted"@
81
@"Committed"@
82
@"Final"@|
83 15 Tom Clegg
|
84 16 Tom Clegg
|requesting_container_uuid|string|When the referenced container ends, the container request is automatically cancelled.|Can be null. If changed to a non-null value, it must refer to a container that is running.||
85 1 Tom Clegg
|
86
|container_uuid|uuid|The container that satisfies this container request.|See "methods" below.||
87
|
88 17 Tom Clegg
|container_count_max|positive integer|Maximum number of containers to start ("attempts").|See "methods" below.||
89
|
90 8 Tom Clegg
|mounts|hash|Objects to attach to the container's filesystem and stdin/stdout.
91
Keys starting with a forward slash indicate objects mounted in the container's filesystem.
92
Other keys are given special meanings here.|
93 1 Tom Clegg
We use "stdin" instead of "/dev/stdin" because literally replacing /dev/stdin with a file would have a confusing effect on many unix programs. The stdin feature only affects the standard input of the first process started in the container; after that, the usual rules apply.|
94
<pre>{
95
 "/input/foo":{
96
  "kind":"collection",
97 9 Tom Clegg
  "portable_data_hash":"d41d8cd98f00b204e9800998ecf8427e+0"
98 1 Tom Clegg
 },
99
 "stdin":{
100
  "kind":"collection_file",
101
  "uuid":"zzzzz-4zz18-yyyyyyyyyyyyyyy",
102 8 Tom Clegg
  "path":"/foo.txt"
103 9 Tom Clegg
 },
104 1 Tom Clegg
 "stdout":{
105 31 Tom Clegg
  "kind":"file",
106 1 Tom Clegg
  "path":"/tmp/a.out"
107 9 Tom Clegg
 }
108 1 Tom Clegg
}</pre>|
109 11 Tom Clegg
|
110 16 Tom Clegg
|runtime_constraints|hash|Restrict the container's access to compute resources and the outside world (in addition to its explicitly stated inputs and output).
111 32 Tom Clegg
-- Each key is the name of a capability, like "internet" or "API" or "clock". The corresponding value is @true@ (the capability must be available in the container's runtime environment) or @false@ (must not) or a value or an array of two numbers indicating an inclusive range. Numeric values are given in basic units (e.g., RAM is given in bytes, not KB or MB or MiB). If a key is omitted, availability of the corresponding capability is acceptable but not necessary.|This is a generalized version of "enforce purity restrictions": it is not a claim that the container will be pure. Rather, it helps us control and track runtime restrictions, which can be helpful when reasoning about whether a given container was pure.
112 10 Tom Clegg
-- In the most basic implementation, no capabilities are defined, and the only acceptable value of this attribute is the empty hash.
113
(TC)Should this structure be extensible like mounts?|
114
<pre>
115 1 Tom Clegg
{
116
  "ram":12000000000,
117
  "vcpus":[1,null]
118
}</pre>|
119
|
120 14 Tom Clegg
|container_image|string|Docker image repository and tag, docker image hash, collection UUID, or collection PDH.|||
121 1 Tom Clegg
|
122
|environment|hash|environment variables and values that should be set in the container environment (@docker run --env@). This augments and (when conflicts exists) overrides environment variables given in the image's Dockerfile.|||
123
|
124 8 Tom Clegg
|cwd|string|initial working directory, given as an absolute path (in the container) or a path relative to the WORKDIR given in the image's Dockerfile. The default is @"."@.||<pre>"/tmp"</pre>|
125 1 Tom Clegg
|
126
|command|array of strings|Command to execute in the container. Default is the CMD given in the image's Dockerfile.|
127
To use a UNIX pipeline, like "echo foo &#124; tr f b", or to interpolate environment variables, make sure your container image has a shell, and use a command like @["sh","-c","echo $PATH &#124; wc"]@.||
128
|
129
|output_path|string|Path to a directory or file inside the container that should be preserved as container's output when it finishes.|This path _must_ be, or be inside, one of the mount targets.
130 14 Tom Clegg
For best performance, point output_path to a writable collection mount.||
131 1 Tom Clegg
|
132 16 Tom Clegg
|priority|number|Higher number means spend more resources (e.g., go ahead of other queued containers, bring up more nodes).
133
-- Zero means a container should not be run on behalf of this request. (Clients are expected to submit ContainerRequests with zero priority in order to prevew the container that will be used to satisfy it.)
134 17 Tom Clegg
-- Priority is null if and only if @state!="Committed"@.||
135 11 Tom Clegg
null
136 1 Tom Clegg
@0@
137 11 Tom Clegg
@1000.5@
138 1 Tom Clegg
@-1@|
139 11 Tom Clegg
|
140 16 Tom Clegg
|expires_at|datetime|After this time, priority is considered to be zero. If the assigned container is running at that time, the container _may_ be cancelled to conserve resources.||
141 11 Tom Clegg
null
142
@2015-07-01T00:00:01Z@|
143
|
144 16 Tom Clegg
|filters|array|Additional constraints for satisfying the request, given in the same form as the @filters@ parameter accepted by the @containers.list@ API.||
145 1 Tom Clegg
@["created_at","<","2015-07-01T00:00:01Z"]@|
146
|
147
148 16 Tom Clegg
h2. "Container" schema
149 1 Tom Clegg
150 9 Tom Clegg
|Attribute|Type|Description|Discussion|Examples|
151
|
152
|uuid, owner_uuid, created_at, modified_at, modified_by_client_uuid,  modified_by_user_uuid|string|Usual Arvados model attributes|||
153
|
154 1 Tom Clegg
|state|string|||
155 20 Tom Clegg
@"Queued"@
156 25 Tom Clegg
@"Locked"@
157 20 Tom Clegg
@"Running"@
158
@"Cancelled"@
159
-@"Failed"@-
160
@"Complete"@|
161 1 Tom Clegg
|
162 26 Tom Clegg
|locked_by_uuid|string|UUID of a token, indicating which dispatch process changed state to Locked|If null, any token can be used to lock. If not null, only the indicated token can modify.
163
Is null if and only if state&notin;{"Locked","Running"}||
164 25 Tom Clegg
|
165 28 Tom Clegg
|auth_uuid|string|UUID of a token to be passed into the container itself, used to access Keep-backed mounts, etc.|Is null if and only if state&notin;{"Locked","Running"}||
166
|
167 25 Tom Clegg
|started_at, finished_at, log||Same as Job attributes in Crunch1|||
168 8 Tom Clegg
|
169 16 Tom Clegg
|environment|hash|Must be equal to a ContainerRequest's environment in order to satisfy the ContainerRequest.|(TC)We could offer a "resolve" process here like we do with mounts: e.g., hash values in the ContainerRequest environment could be resolved according to the given "kind". I propose we leave room for this feature but don't add it yet.||
170 9 Tom Clegg
|
171 16 Tom Clegg
|cwd, command, output_path|string|Must be equal to the corresponding values in a ContainerRequest in order to satisfy that ContainerRequest.|||
172 9 Tom Clegg
|
173 16 Tom Clegg
|mounts|hash|Must contain the same keys as the ContainerRequest being satisfied. Each value must be within the range of values described in the ContainerRequest _at the time the Container is assigned to the ContainerRequest._|||
174 14 Tom Clegg
|
175 16 Tom Clegg
|runtime_constraints|hash|Compute resources, and access to the outside world, that are/were available to the container.
176
-- Generally this will contain additional keys that are not present in any corresponding ContainerRequests: for example, even if no ContainerRequests specified constraints on the number of CPU cores, the number of cores actually used will be recorded here.|
177
Permission/access types will change over time and it may be hard/impossible to translate old types to new. Such cases may cause old Containers to be inelegible for assignment to new ContainerRequests.
178
-- (TC)Is it permissible for this to gain keys over time? For example, a container scheduler might not be able to predict how many CPU cores will be available until the container starts.||
179 1 Tom Clegg
|
180 9 Tom Clegg
|output|string|Portable data hash of the output collection.|||
181
|
182 21 Tom Clegg
|exit_code|integer|Process exit code.|Is null if and only if @state!="Complete"@|
183
@null@
184
@0@
185
@1@
186
@129@|
187
|
188 16 Tom Clegg
|-pure-|-boolean-|-The container's output is thought to be dependent solely on its inputs, i.e., it is expected to produce identical output if repeated.-|
189
We want a feature along these lines, but "pure" seems to be a conclusion we can come to after examining various facts -- rather than a property of an individual container execution event -- and it probably needs something more subtle than a boolean.||
190 8 Tom Clegg
|
191 16 Tom Clegg
|container_image|string|Portable data hash of a collection containing the docker image used to run the container.|(TC) *If* docker image hashes can be verified efficiently, we can use the native docker image hash here instead of a collection PDH.||
192 10 Tom Clegg
|
193 8 Tom Clegg
|progress|number|A number between 0.0 and 1.0 describing the fraction of work done.|
194 16 Tom Clegg
If a container submits containers of its own, it should update its own progress as the child containers progress/finish.||
195 8 Tom Clegg
|
196 16 Tom Clegg
|priority|number|Priority assigned by the system, taking into account the priorities of all associated ContainerRequests.|||
197 8 Tom Clegg
198
h2. Mount types
199
200
The "mounts" hash is the primary mechanism for adding data to the container at runtime (beyond what is already in the container image).
201
202
Each value of the "mounts" hash is itself a hash, whose "kind" key determines the handler used to attach data to the container.
203 9 Tom Clegg
204 1 Tom Clegg
|Mount type|@kind@|Expected keys|Description|Examples|Discussion|
205 9 Tom Clegg
|
206
|Arvados data collection|@collection@|
207 16 Tom Clegg
@"portable_data_hash"@ _or_ @"uuid"@ _may_ be provided. If not provided, a new collection will be created. This is useful when @"writable":true@ and the container's @output_path@ is (or is a subdirectory of) this mount target.
208 8 Tom Clegg
@"writable"@ may be provided with a @true@ or @false@ to indicate the path must (or must not) be writable. If not specified, the system can choose.
209 1 Tom Clegg
@"path"@ may be provided, and defaults to @"/"@.|
210 16 Tom Clegg
At container startup, the target path will have the same directory structure as the given path within the collection. Even if the files/directories are writable in the container, modifications will _not_ be saved back to the original collections when the container ends.|
211 8 Tom Clegg
<pre>
212 9 Tom Clegg
{
213 1 Tom Clegg
 "kind":"collection",
214
 "uuid":"...",
215
 "path":"/foo.txt"
216
}
217
218 8 Tom Clegg
{
219 1 Tom Clegg
 "kind":"collection",
220 13 Tom Clegg
 "uuid":"..."
221 8 Tom Clegg
}
222 1 Tom Clegg
</pre>||
223
|
224
|Git tree|@git_tree@|
225 8 Tom Clegg
One of {@"git-url"@, @"repository_name"@, @"uuid"@} must be provided.
226 1 Tom Clegg
One of {@"commit"@, @"revisions"@} must be provided.
227 14 Tom Clegg
"path" may be provided. The default path is "/".|
228 16 Tom Clegg
At container startup, the target path will have the source tree indicated by the given revision. The @.git@ metadata directory _will not_ be available: typically the system will use @git-archive@ rather than @git-checkout@ to prepare the target directory.
229
-- If a value is given for @"revisions"@, it will be resolved to a set of commits (as desribed in the "ranges" section of git-revisions(1)) and the container request will be satisfiable by any commit in that set.
230 14 Tom Clegg
-- If a value is given for @"commit"@, it will be resolved to a single commit, and the tree resulting from that commit will be used.
231 8 Tom Clegg
-- @"path"@ can be used to select a subdirectory or a single file from the tree indicated by the selected commit.
232 1 Tom Clegg
-- Multiple commits can resolve to the same tree: for example, the file/directory given in @"path"@ might not have changed between commits A and B.
233 16 Tom Clegg
-- The resolved mount (found in the Container record) will have only the "kind" key and a "blob" or "tree" key indicating the 40-character hash of the git tree/blob used.|
234 1 Tom Clegg
<pre>
235 8 Tom Clegg
{
236
 "kind":"git_tree",
237
 "uuid":"zzzzz-s0uqq-xxxxxxxxxxxxxxx",
238 1 Tom Clegg
 "commit":"master"
239
}
240
241
{
242
 "kind":"git_tree",
243 8 Tom Clegg
 "uuid":"zzzzz-s0uqq-xxxxxxxxxxxxxxx",
244 5 Tom Clegg
 "commit_range":"bugfix^..master",
245
 "path":"/crunch_scripts/grep"
246 1 Tom Clegg
}
247 8 Tom Clegg
</pre>||
248 1 Tom Clegg
|
249
|Temporary directory|@tmp@|
250 27 Tom Clegg
@"capacity"@: capacity (in bytes) of the storage device.
251
@"device_type"@ (optional, default "network"): one of @{"ram", "ssd", "disk", "network"}@ indicating the acceptable level of performance.|
252
At container startup, the target path will be empty. When the container finishes, the content will be discarded. This will be backed by a storage mechanism no slower than the specified type.|
253 1 Tom Clegg
<pre>
254 11 Tom Clegg
{
255 1 Tom Clegg
 "kind":"tmp",
256 27 Tom Clegg
 "capacity":100000000000
257 1 Tom Clegg
}
258 27 Tom Clegg
259
{
260
 "kind":"fasttmp",
261
 "capacity":1000000000,
262
 "device_type":"ram"
263
}
264 13 Tom Clegg
</pre>||
265 12 Tom Clegg
|
266
|Keep|@keep@|
267
Expose all readable collections via arv-mount.|Requires suitable runtime constraints.|
268
<pre>
269 13 Tom Clegg
{
270 2 Tom Clegg
 "kind":"keep"
271 8 Tom Clegg
}
272 1 Tom Clegg
</pre>||
273
|
274 30 Tom Clegg
|Mounted file or directory|@file@|
275
@"path"@: absolute path (inside the container) of a file or directory that is (or is inside) another mount target.|Can be used for "stdin" and "stdout" targets.|
276
<pre>
277
{
278
 "kind":"file",
279
 "path":"/mounted_tmp/a.out"
280
}
281
</pre>||
282
|
283 1 Tom Clegg
284
h2. Permissions
285
286 16 Tom Clegg
Users own ContainerRequests but the system owns Containers.  Users get permission to read Containers by virtue of linked ContainerRequests.
287 1 Tom Clegg
288
h2. API methods
289
290
Changes from the usual REST APIs:
291
292 16 Tom Clegg
h3. arvados.v1.container_requests.create and .update
293 8 Tom Clegg
294 11 Tom Clegg
These methods can fail when objects referenced in the "mounts" hash do not exist, or the acting user has insufficient permission on them.
295
296
If @state="Uncommitted"@:
297 16 Tom Clegg
* has null @priority@.
298
* can have its @container_uuid@ reset to null by a client.
299 1 Tom Clegg
* can have its @container_uuid@ set to a non-null value by a system process.
300
301
If @state="Committed"@:
302
* has non-null @priority@.
303 17 Tom Clegg
* can have its @priority@ changed (but not to null).
304
* can have its @container_count_max@ changed.
305
* can have its @container_uuid@ changed by the system. (This allows the system to re-attempt a failed container.)
306
* cannot be modified in other ways
307 11 Tom Clegg
308 17 Tom Clegg
If @state="Final"@:
309
* cannot be modified.
310
311 16 Tom Clegg
h3. arvados.v1.container_requests.cancel
312 8 Tom Clegg
313 11 Tom Clegg
Set @priority@ to zero.
314
315 16 Tom Clegg
h3. arvados.v1.container_requests.satisfy
316 11 Tom Clegg
317 16 Tom Clegg
Find or create a suitable container, and update @container_uuid@.
318 11 Tom Clegg
319 16 Tom Clegg
Return an error if @container_uuid@ is not null.
320 11 Tom Clegg
321
Q: Can this be requested during create? Create+satisfy is a common operation so having a way to do it in a single API call might be a worthwhile convenience.
322
323 1 Tom Clegg
Q: Better name?
324
325 16 Tom Clegg
h3. arvados.v1.containers.create and .update
326 1 Tom Clegg
327
These methods are not callable except by system processes.
328
329 16 Tom Clegg
h3. arvados.v1.containers.progress
330 1 Tom Clegg
331 16 Tom Clegg
This method permits specific types of updates while a container is running: update progress, record success/failure.
332 1 Tom Clegg
333 16 Tom Clegg
Q: [How] can a client submitting container B indicate it shouldn't run unless/until container A succeeds?
334 1 Tom Clegg
335 29 Tom Clegg
h3. arvados.v1.containers.get_auth
336
337
@GET /arvados/v1/containers/{uuid}/get_auth@
338
339
Given the uuid of a container, return the api_client_authorization record indicated by its auth_uuid. The token used to make this request must be the one indicated by the container's locked_by_uuid.
340
341
342 1 Tom Clegg
h2. Debugging
343
344
Q: Need any infrastructure debug-logging controls in this API?
345
346 16 Tom Clegg
Q: Need any container debug-logging controls in this API? Or just use environment vars?
347 1 Tom Clegg
348 16 Tom Clegg
h2. Scheduling and running containers
349 11 Tom Clegg
350 16 Tom Clegg
Q: When/how should we implement a hooks for futures/promises: e.g., "run container Y when containers X0, X1, and X2 have finished"?
351 11 Tom Clegg
352 24 Tom Clegg
(PA) Having a field specifying "wait until time X to run this container" would be generally useful for cron-style tasks.
353
354
355 11 Tom Clegg
h2. Accounting
356
357
A complete design for resource accounting and quota is out of scope here, but we do assert here that the API makes it feasible to retain accounting data.
358
359 16 Tom Clegg
It should be possible to retrieve, for a given container, a complete set of resource allocation intervals, each one including:
360 11 Tom Clegg
* interval start time
361
* interval end time (presented as null or now if the interval hasn't ended yet)
362 1 Tom Clegg
* user uuid
363
* container request id
364
* container request priority
365
* container state
366 17 Tom Clegg
367
h2. TBD
368
369
How does a client get a list of previous (presumably failed) container attempts for a given request?
370 23 Tom Clegg
* Add an array property, like previous_ or attempted_container_uuids?
371
372
(PA) I think we should distinguish between infrastructure failure and task failure by distinguishing between "TempFail" and "PermFail" in the container state. "TempFail" shouldn't count againt the container_count_max count, or alternately we only honor container_count_max for "TempFail" tasks and don't retry "PermFail". Ideally, "TempFail" containers should retry forever, but with a backoff. One way to do the backoff is to schedule the container to run at a specific time in the future.
373 18 Peter Amstutz
374
375
h2. References
376
377
Should consider how this fits in with Kubernetes notion of jobs:
378
379
https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/jobs.md