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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "containers"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/containers@
  15
  16 Object type: @dz642@
  17
  18 Example UUID: @zzzzz-dz642-0123456789abcde@
  19
  20 h2. Resource
  21
  22 A container is work order to be dispatched to an Arvados cluster to perform some computational work.  A container is created in response to a container request.  See "computing with Crunch":{{site.baseurl}}/api/execution.html for details.
  23
  24 Each Container offers the following attributes, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Notes|
  28 |state|string|The allowed states are "Queued", "Locked", "Running", "Cancelled" and "Complete".|See "Container states":#container_states for more details.|
  29 |started_at|datetime|When this container started running.|Null if container has not yet started.|
  30 |finished_at|datetime|When this container finished.|Null if container has not yet finished.|
  31 |log|string|Portable data hash of a collection containing the log messages produced when executing the container.|Null if container has not yet started. The Crunch system will periodically update this field for a running container.|
  32 |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.|Must be equal to a ContainerRequest's environment in order to satisfy the ContainerRequest.|
  33 |cwd|string|Initial working directory.|Must be equal to a ContainerRequest's cwd in order to satisfy the ContainerRequest.|
  34 |command|array of strings|Command to execute.| Must be equal to a ContainerRequest's command in order to satisfy the ContainerRequest.|
  35 |output_path|string|Path to a directory or file inside the container that should be preserved as this container's output when it finishes.|Must be equal to a ContainerRequest's output_path in order to satisfy the ContainerRequest.|
  36 |output_glob|array of strings|Glob patterns determining which files will be included in the output collection. See corresponding attribute in the "container_requests resource":container_requests.html.|Must be equal to a ContainerRequest's output_glob in order to satisfy the ContainerRequest. See "Glob patterns":#glob_patterns for more details.|
  37 |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.|See "Mount types":#mount_types for more details.|
  38 |secret_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.|Not returned in API responses. Reset to empty when state is "Complete" or "Cancelled".|
  39 |runtime_constraints|hash|Compute resources, and access to the outside world, that are / were available to the container.
  40 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.|e.g.,
  41 <pre><code>{
  42   "ram":12000000000,
  43   "vcpus":2,
  44   "API":true
  45 }</code></pre>See "Runtime constraints":#runtime_constraints for more details.|
  46 |runtime_status|hash|Information related to the container's run, including its steps. Some keys have specific meaning and are described later in this page.|e.g.,
  47 <pre><code>{
  48   "error": "This container won't be successful because at least one step has already failed."
  49 }</code></pre>See "Runtime status":#runtime_status for more details.|
  50 |scheduling_parameters|hash|Parameters to be passed to the container scheduler when running this container.|e.g.,<pre><code>{
  51 "partitions":["fastcpu","vfastcpu"]
  52 }</code></pre>See "Scheduling parameters":#scheduling_parameters for more details.|
  53 |output|string|Portable data hash of the output collection.|Null if the container is not yet finished.|
  54 |container_image|string|Portable data hash of a collection containing the docker image used to run the container.||
  55 |progress|number|A number between 0.0 and 1.0 describing the fraction of work done.||
  56 |priority|integer|Range 0-1000.  Indicate scheduling order preference.|Currently assigned by the system as the max() of the priorities of all associated ContainerRequests.  See "container request priority":container_requests.html#priority.|
  57 |exit_code|integer|Process exit code.|Null if container process has not exited yet.|
  58 |auth_uuid|string|UUID of a token to be passed into the container itself, used to access Keep-backed mounts, etc.  Automatically assigned.|Null if state∉{"Locked","Running"} or if @runtime_token@ was provided.|
  59 |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 this container.|Null if state∉{"Locked","Running"}|
  60 |runtime_token|string|A v2 token to be passed into the container itself, used to access Keep-backed mounts, etc.|Not returned in API responses.  Reset to null when state is "Complete" or "Cancelled".|
  61 |gateway_address|string|Address (host:port) of gateway server.|Internal use only.|
  62 |interactive_session_started|boolean|Indicates whether @arvados-client shell@ has been used to run commands in the container, which may have altered the container's behavior and output.||
  63 |output_storage_classes|array of strings|The storage classes that will be used for the log and output collections of this container||
  64 |output_properties|hash|User metadata properties to set on the output collection.|
  65 |cost|number|Estimated cost of the cloud VM used to run the container.|0 if not available.|
  66 |subrequests_cost|number|Total estimated cumulative cost of container requests submitted by this container.|0 if not available.|
  67
  68 h2(#container_states). Container states
  69
  70 table(table table-bordered table-condensed).
  71 |_. State&nbsp;value|_. Description|_. Allowed next|
  72 |Queued|Waiting for a dispatcher to lock it and try to run the container.|Locked, Cancelled|
  73 |Locked|A dispatcher has "taken" the container and is allocating resources for it. The container has not started yet.|Queued, Running, Cancelled|
  74 |Running|Resources have been allocated and the contained process has been started (or is about to start). Crunch-run _must_ set state to Running _before_ there is any possibility that user code will run in the container.|Complete, Cancelled|
  75 |Complete|Container was running, and the contained process/command has exited.|Cancelled|
  76 |Cancelled|The container did not run long enough to produce an exit code. This includes cases where the container didn't even start, cases where the container was interrupted/killed before it exited by itself (e.g., priority changed to 0), and cases where some problem prevented the system from capturing the contained process's exit status (exit code and output).|-|
  77
  78 See "Controlling container reuse":{{site.baseurl}}/admin/controlling-container-reuse.html for details about changing state from @Complete@ to @Cancelled@
  79
  80 h2(#mount_types). {% include 'mount_types' %}
  81
  82 h2(#runtime_constraints). {% include 'container_runtime_constraints' %}
  83
  84 h2(#runtime_status). Runtime status
  85
  86 Runtime status provides container's relevant information about its progress even while it's still in Running state. This is used to avoid reusing containers that have not yet failed but will definitely do, and also for easier workflow debugging.
  87
  88 The following keys have well known meanings:
  89
  90 table(table table-bordered table-condensed).
  91 |_. Key|_. Type|_. Description|_. Notes|
  92 |error|string|The existance of this key indicates the container will definitely fail, or has already failed.|Optional.|
  93 |warning|string|Indicates something unusual happened or is currently happening, but isn't considered fatal.|Optional.|
  94 |activity|string|A message for the end user about what state the container is currently in.|Optional.|
  95 |errorDetail|string|Additional structured error details.|Optional.|
  96 |warningDetail|string|Additional structured warning details.|Optional.|
  97 |preemptionNotice|string|Details about any cloud provider scheduled interruption to the instance running this container.|Existence of this key indicates the container likely was (or will soon be) @Cancelled@ due to an instance interruption.|
  98
  99 h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %}
 100
 101 h2(#glob_patterns). {% include 'container_glob_patterns' %}
 102
 103 h2. Methods
 104
 105 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 106
 107 Required arguments are displayed in %{background:#ccffcc}green%.
 108
 109 Supports federated @get@ and @list@.
 110
 111 h3(#create). create
 112
 113 Create a new Container.
 114
 115 This API requires admin privileges. In normal operation, it should not be used at all.
 116
 117 Arguments:
 118
 119 table(table table-bordered table-condensed).
 120 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 121 {background:#ccffcc}.|container|object|Container resource|request body||
 122
 123 h3. delete
 124
 125 Delete a Container.
 126
 127 This API requires admin privileges. In normal operation, it should not be used at all. API clients like Workbench might not work correctly when a container request references a container that has been deleted.
 128
 129 Arguments:
 130
 131 table(table table-bordered table-condensed).
 132 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 133 {background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
 134
 135 h3. get
 136
 137 Get a Container's metadata by UUID.
 138
 139 Arguments:
 140
 141 table(table table-bordered table-condensed).
 142 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 143 {background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
 144
 145 h3. list
 146
 147 List containers.
 148
 149 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 150
 151 h3. update
 152
 153 Update attributes of an existing Container.
 154
 155 Arguments:
 156
 157 table(table table-bordered table-condensed).
 158 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 159 {background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
 160 |container|object||query||
 161
 162 h3. auth
 163
 164 Get the api_client_authorization record indicated by this container's auth_uuid, which belongs to the container's locked_by_uuid.
 165
 166 table(table table-bordered table-condensed).
 167 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 168 {background:#ccffcc}.|uuid|string||path||