Arvados

h1. Jobs API (DRAFT)

h2. "Job" schema

|Attribute|Type|Description|Discussion|Examples|

|uuid, owner_uuid, modified_by_client_uuid,  modified_by_user_uuid, created_at, modified_at||Standard fields|||

|

|name, description||User-friendly information about the job|(TC)Does "user friendly" just mean "user controlled", or is Arvados expected to do something here?||

|

|state, started_at, finished_at, log||Same as current job|||

|

|created_by_job_uuid|uuid|The job that spawned this job, or null if it is a root job initiated by a user.|||

|

|input_object|hash|functionally the same as script_parameters|

(TC)Why _object, not just input?|{"input":"d41d8cd98f00b204e9800998ecf8427e+0"}|

|

|output_object|hash|output of the job (jobs are no longer required to write to Keep, could also have several fields for multiple output collections.)|

(PA)Changing the basic output type from a collection to a JSON object is important for native CWL support.

(TC)Need examples of how "output is one collection", "output is multiple collections", "output is collections plus other stuff(?)", and "output is other stuff without collections" are to be encoded.

(TC)Ditto re _object||

|

|pure|boolean|Whether this job can be reused (== "nondeterministic" ref #3555)|

(TC)"Can be reused" can only be judged by the reuser, not the job itself. If the field is called "pure" it should mean "pure", i.e., output depends only on inputs, not randomness or external state.

(TC)Is this merely an assertion by the submitter? Is the job itself expected to set or reset it? Does the system behave differently while running the job (e.g., different firewall rules, some APIs disabled)? [Under what conditions] is the system allowed to change it from true to false? Is null allowed, presumably signifying "not known"?|@null@ (?)

@true@

@false@|

|

|git_repository, git_commit, resolved_git_commit|string|Basically same as before, except that the user supplies "git_commit" and the API server fills in "resolved_git_commit" to the full SHA1 hash instead of rewriting the user-supplied field.|

(TC)Perhaps we should take the opportunity to support these semantics on multiple git repositories per job (#3820).

(TC)Not keen on resolved_git_commit. Prefer more git-like language, like git_commit_sha1.

(TC)If git_commit is git_commit_range, the original "which versions are acceptable" constraint wouldn't be lost, and it would be possible to change git_commit_sha1 while a job is queued in order to increase reuse.||

|

|docker_image, resolved_docker_image|string|Similar to git, the user supplies docker_image and the API server resolves that to resolved_docker_image.  Also this ought to be the Docker image hash, not the collection PDH.|

(TC)We can use a docker image hash only if we can safely verify docker image hashes. Otherwise, renaming a new docker image to {old-hash}.tar breaks reproducibility.||

|

|git_checkout_dir, temp_dir, output_dir, keep_dir|string|Desired paths *inside the docker container* where git checkout, temporary directory, output directories and keep mount should go.|

(TC)What are the defaults? This flexibility seems useful for a job that submits other jobs (like a workflow/pipeline runner) but would be cumbersome to specify every time ("remind me, where does workflow runner X expect its keep mount to be?).

(TC)What is the significance of output_dir? [How] does Crunch merge the content of the @output_dir@ and the value of the @output@ attribute to arrive at the final output?||

|

|stdin|string|A file in Keep that should sent to standard input.|

(TC)Is this required to be a regular file or can it be a pipe?

(TC)If the job does not finish reading it, is that an error, like @set -o pipefail@ in bash?|@{pdh}/foo.txt@|

|

|stdout|string|A filename in the output directory to which standard output should be directed.|(TC)If this is not given, is stdout sent to stderr/logs as it is now?||

|

|environment|hash|environment variables and values that should be set in the container environment (docker run --env)|

(TC)If this contains variables already used by Crunch (TASK_KEEPMOUNT), which has precedence?||

|

|initial_collection|uuid|A collection describing the starting contents of the output directory.|

(TC)Not a fan of this attribute name.

(TC)Is it an error if this collection is not one of the inputs? Or do all provenance queries need to treat this separately?

(TC)Perhaps better if each @input@ item were available at @{job_workdir}/input/{inputkey}@ and the "preload" behavior could be achieved by setting @output_dir@ to @input/foo@?||

|

|cwd|string|initial working directory, given as an absolute path (in the container) or relative to {job_workdir}. Default "output".||/tmp

output

input/foo|

|

|command|array of strings|parameters to the actual executable command line.|

(TC)Possible to specify a pipe, like "echo foo | tr f b"? Any shell variables supported? Or do you just use @["sh","-c","echo $PATH | wc"]@ if you want a shell?||

|

|progress|number|A number between 0.0 and 1.0 describing the fraction of work done.|

(TC)How does this relate to child tasks? E.g., is a job supposed to update this itself as its child tasks complete?||

|

|runtime_debugging|boolean|Enable debug logging for the infrastructure (such as arv-mount) (this might get logged privately away from the end user)|

(TC)This doesn't sound like it should be a job attribute. Infrastructure debugging shouldn't require touching users' job records. An analogous user feature would be useful, but perhaps it just boils down to adding DEBUG=1 to @environment@?||

|

|priority|number|Higher number means spend more resources (e.g., go ahead of other queued jobs, bring up more nodes)|(TC)Do we need something more subtle than a single number?

(TC)What if a high priority job is waiting for a low priority job to finish?|@0@, @1000.5@, @-1@|

Q: When two identical pure jobs were submitted with reuse enabled, and only one runs, how do the two job records differ?

* (TC)I'm assuming this has to result in two job records, not one: otherwise fields like name, description, and priority will be confusing.

h2. "jobs" API methods

Reuse and reproducibility require some changes to the usual REST APIs.

h3. arvados.v1.jobs.create

Q: How does "find or create" work?

Q: How does a client submitting job B indicate it shouldn't run unless/until job A succeeds?

h3. arvados.v1.jobs.update

Most attributes cannot be changed after a job starts. Some attributes _can_ be changed:

* name, description, priority

* output, progress, state, finished_at, log (ideally only by the job itself - should this be enforced?)

* modified_*

* Q: (any more?)

h3. arvados.v1.jobs.get

Q: Should this omit mutable attributes when retrieved by a pure job? (Ideally, pure jobs should not be able to retrieve data other than their stated immutable / content-addressed inputs, either through Keep or through the API.)