doc/api/methods/container_requests.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "container_requests"
   6
   7 ...
   8
   9 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/container_requests@
  10
  11 Object type: @xvhdp@
  12
  13 Example UUID: @zzzzz-xvhdp-0123456789abcde@
  14
  15 h2. Resource
  16
  17 A container request is a request for the Arvados cluster to perform some computational work.  See "computing with Crunch":{{site.baseurl}}/api/execution.html for details.
  18
  19 Each ContainerRequest offers the following attributes, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  20
  21 All attributes are optional, unless otherwise marked as required.
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Notes|
  25 |name|string|The name of the container_request.||
  26 |description|string|The description of the container_request.||
  27 |properties|hash|Client-defined structured data that does not affect how the container is run.||
  28 |state|string|The allowed states are "Uncommitted", "Committed", and "Final".|Once a request is Committed, the only attributes that can be modified are priority, container_uuid, and container_count_max. A request in the "Final" state cannot have any of its functional parts modified (i.e., only name, description, and properties fields can be modified).|
  29 |requesting_container_uuid|string|The uuid of the parent container that created this container_request, if any. Represents a process tree.|The priority of this container_request is inherited from the parent container, if the parent container is cancelled, this container_request will be cancelled as well.|
  30 |container_uuid|string|The uuid of the container that satisfies this container_request. The system may return a preexisting Container that matches the container request criteria. See "Container reuse":#container_reuse for more details.|Container reuse is the default behavior, but may be disabled with @use_existing: false@ to always create a new container.|
  31 |container_count_max|integer|Maximum number of containers to start, i.e., the maximum number of "attempts" to be made.||
  32 |mounts|hash|Objects to attach to the container's filesystem and stdin/stdout.|See "Mount types":#mount_types for more details.|
  33 |runtime_constraints|hash|Restrict the container's access to compute resources and the outside world.|Required when in "Committed" state. e.g.,<pre><code>{
  34   "ram":12000000000,
  35   "vcpus":2,
  36   "API":true
  37 }</code></pre>See "Runtime constraints":#runtime_constraints for more details.|
  38 |scheduling_parameters|hash|Parameters to be passed to the container scheduler when running this container.|e.g.,<pre><code>{
  39 "partitions":["fastcpu","vfastcpu"]
  40 }</code></pre>See "Scheduling parameters":#scheduling_parameters for more details.|
  41 |container_image|string|Portable data hash of a collection containing the docker image to run the container.|Required.|
  42 |environment|hash|Environment variables and values that should be set in the container environment (@docker run --env@). This augments and (when conflicts exist) overrides environment variables given in the image's Dockerfile.||
  43 |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.|Required.|
  44 |command|array of strings|Command to execute in the container.|Required. e.g., @["echo","hello"]@|
  45 |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. For best performance, point output_path to a writable collection mount.|Required.|
  46 |priority|integer|Higher value means spend more resources on this container_request, i.e., go ahead of other queued containers, bring up more nodes etc.|Priority 0 means a container should not be run on behalf of this request. Clients are expected to submit container requests with zero priority in order to preview the container that will be used to satisfy it. Priority can be null if and only if state!="Committed".|
  47 |expires_at|datetime|After this time, priority is considered to be zero.|Not yet implemented.|
  48 |use_existing|boolean|If possible, use an existing (non-failed) container to satisfy the request instead of creating a new one.|Default is true|
  49 |filters|string|Additional constraints for satisfying the container_request, given in the same form as the filters parameter accepted by the container_requests.list API.|
  50
  51 h2(#mount_types). {% include 'mount_types' %}
  52
  53 h2(#runtime_constraints). {% include 'container_runtime_constraints' %}
  54
  55 h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %}
  56
  57 h2(#container_reuse). Container reuse
  58
  59 When a container request is "Committed", the system will try to find and reuse any preexisting Container with the same exact command, cwd, environment, output_path, container_image, mounts, and runtime_constraints as this container request. The serialized fields environment, mounts and runtime_constraints are sorted to facilitate comparison.
  60
  61 The system will use the following scheme to determine which Container to consider for reuse: A Container with the same exact command, cwd, environment, output_path, container_image, mounts, and runtime_constraints as this container request and,
  62 * The oldest successfully finished container, i.e., in state "Complete" with exit_code of 0. If matching containers with different outputs are found, the system will forgo reusing any of these finished containers and instead look for suitable containers in other states
  63 * The oldest "Running" container with the highest progress, i.e., the container that is most likely to finish first
  64 * The oldest "Locked" container with the highest priority, i.e., the container that is most likely to start first
  65 * The oldest "Queued" container with the highest priority, i.e, the container that is most likely to start first
  66
  67 h2(#cancel_container). Canceling a container request
  68
  69 A container request may be canceled by setting it's priority to 0, using an update call.
  70
  71 When a container request is canceled, it will still reflect the state of the Container it is associated with via the container_uuid attribute. If that Container is being reused by any other container_requests that are still active, i.e., not yet canceled, that Container may continue to run or be scheduled to run by the system in future. However, if no other container_requests are using that Contianer, then the Container will get canceled as well.
  72
  73 h2. Methods
  74
  75 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  76
  77 Required arguments are displayed in %{background:#ccffcc}green%.
  78
  79 h2(#create). create
  80
  81 Create a new container request.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|container_request|object|Container request resource.|request body||
  88
  89
  90 The request body must include the required attributes command, container_image, cwd, and output_path. It can also inlcude other attributes such as environment, mounts, and runtime_constraints.
  91
  92 h3. delete
  93
  94 Delete an existing container request.
  95
  96 Arguments:
  97
  98 table(table table-bordered table-condensed).
  99 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 100 {background:#ccffcc}.|uuid|string|The UUID of the container request in question.|path||
 101
 102 h3. get
 103
 104 Get a container request's metadata by UUID.
 105
 106 Arguments:
 107
 108 table(table table-bordered table-condensed).
 109 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 110 {background:#ccffcc}.|uuid|string|The UUID of the container request in question.|path||
 111
 112 h3. list
 113
 114 List container_requests.
 115
 116 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 117
 118 See the create method documentation for more information about container request-specific filters.
 119
 120 h3. update
 121
 122 Update attributes of an existing container request.
 123
 124 Arguments:
 125
 126 table(table table-bordered table-condensed).
 127 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 128 {background:#ccffcc}.|uuid|string|The UUID of the container request in question.|path||
 129 |container_request|object||query||
 130
 131 {% include 'notebox_begin' %}
 132 Setting the priority of a committed container_request to 0 may cancel a running container assigned for it.
 133 See "Canceling a container request":{{site.baseurl}}/api/methods/container_requests.html#cancel_container for further details.
 134 {% include 'notebox_end' %}