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|UUID or portable data hash of a collection containing the log messages produced when executing the container.|PDH after the container is finished, otherwise UUID or null.|
  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 |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.|
  37 |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".|
  38 |runtime_constraints|hash|Compute resources, and access to the outside world, that are / were available to the container.
  39 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.,
  40 <pre><code>{
  41   "ram":12000000000,
  42   "vcpus":2,
  43   "API":true
  44 }</code></pre>See "Runtime constraints":#runtime_constraints for more details.|
  45 |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.,
  46 <pre><code>{
  47   "error": "This container won't be successful because at least one step has already failed."
  48 }</code></pre>See "Runtime status":#runtime_status for more details.|
  49 |scheduling_parameters|hash|Parameters to be passed to the container scheduler when running this container.|e.g.,<pre><code>{
  50 "partitions":["fastcpu","vfastcpu"]
  51 }</code></pre>See "Scheduling parameters":#scheduling_parameters for more details.|
  52 |output|string|Portable data hash of the output collection.|Null if the container is not yet finished.|
  53 |container_image|string|Portable data hash of a collection containing the docker image used to run the container.||
  54 |progress|number|A number between 0.0 and 1.0 describing the fraction of work done.||
  55 |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.|
  56 |exit_code|integer|Process exit code.|Null if container process has not exited yet.|
  57 |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.|
  58 |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"}|
  59 |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".|
  60 |gateway_address|string|Address (host:port) of gateway server.|Internal use only.|
  61 |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.||
  62 |output_storage_classes|array of strings|The storage classes that will be used for the log and output collections of this container||
  63 |output_properties|hash|User metadata properties to set on the output collection.|
  64
  65 h2(#container_states). Container states
  66
  67 table(table table-bordered table-condensed).
  68 |_. State|_. Sgnificance|_. Allowed next|
  69 |Queued|Waiting for a dispatcher to lock it and try to run the container.|Locked, Cancelled|
  70 |Locked|A dispatcher has "taken" the container and is allocating resources for it. The container has not started yet.|Queued, Running, Cancelled|
  71 |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|
  72 |Complete|Container was running, and the contained process/command has exited.|Cancelled|
  73 |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).|-|
  74
  75 See "Controlling container reuse":{{site.baseurl}}/admin/controlling-container-reuse.html for details about changing state from @Complete@ to @Cancelled@
  76
  77 h2(#mount_types). {% include 'mount_types' %}
  78
  79 h2(#runtime_constraints). {% include 'container_runtime_constraints' %}
  80
  81 h2(#runtime_status). Runtime status
  82
  83 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.
  84
  85 The following keys have well known meanings:
  86
  87 table(table table-bordered table-condensed).
  88 |_. Key|_. Type|_. Description|_. Notes|
  89 |error|string|The existance of this key indicates the container will definitely fail, or has already failed.|Optional.|
  90 |warning|string|Indicates something unusual happened or is currently happening, but isn't considered fatal.|Optional.|
  91 |activity|string|A message for the end user about what state the container is currently in.|Optional.|
  92 |errorDetail|string|Additional structured error details.|Optional.|
  93 |warningDetail|string|Additional structured warning details.|Optional.|
  94
  95 h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %}
  96
  97 h2. Methods
  98
  99 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 100
 101 Required arguments are displayed in %{background:#ccffcc}green%.
 102
 103 Supports federated @get@ and @list@.
 104
 105 h2(#create). create
 106
 107 Create a new Container.
 108
 109 Arguments:
 110
 111 table(table table-bordered table-condensed).
 112 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 113 {background:#ccffcc}.|container|object|Container resource|request body||
 114
 115 h3. delete
 116
 117 Delete a Container.
 118
 119 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.
 120
 121 Arguments:
 122
 123 table(table table-bordered table-condensed).
 124 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 125 {background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
 126
 127 h3. get
 128
 129 Get a Container's metadata by UUID.
 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 Container in question.|path||
 136
 137 h3. list
 138
 139 List containers.
 140
 141 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 142
 143 h3. update
 144
 145 Update attributes of an existing Container.
 146
 147 Arguments:
 148
 149 table(table table-bordered table-condensed).
 150 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 151 {background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
 152 |container|object||query||
 153
 154 h3. auth
 155
 156 Get the api_client_authorization record indicated by this container's auth_uuid, which belongs to the container's locked_by_uuid.
 157
 158 table(table table-bordered table-condensed).
 159 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 160 {background:#ccffcc}.|uuid|string||path||