X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/30fc42873b2c82e72a95393eb053abf1f7052618..92bf76b1077282126b8a1c446458c6618a36e5d5:/doc/api/methods/containers.html.textile.liquid diff --git a/doc/api/methods/containers.html.textile.liquid b/doc/api/methods/containers.html.textile.liquid index d59c66edc3..1d2fed768c 100644 --- a/doc/api/methods/containers.html.textile.liquid +++ b/doc/api/methods/containers.html.textile.liquid @@ -28,7 +28,7 @@ table(table table-bordered table-condensed). |state|string|The allowed states are "Queued", "Locked", "Running", "Cancelled" and "Complete".|See "Container states":#container_states for more details.| |started_at|datetime|When this container started running.|Null if container has not yet started.| |finished_at|datetime|When this container finished.|Null if container has not yet finished.| -|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.| +|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.| |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.| |cwd|string|Initial working directory.|Must be equal to a ContainerRequest's cwd in order to satisfy the ContainerRequest| |command|array of strings|Command to execute.| Must be equal to a ContainerRequest's command in order to satisfy the ContainerRequest.| @@ -52,16 +52,22 @@ Generally this will contain additional keys that are not present in any correspo |output|string|Portable data hash of the output collection.|Null if the container is not yet finished.| |container_image|string|Portable data hash of a collection containing the docker image used to run the container.|| |progress|number|A number between 0.0 and 1.0 describing the fraction of work done.|| -|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 .| -|exit_code|integer|Process exit code.|Null if state!="Complete"| +|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.| +|exit_code|integer|Process exit code.|Null if container process has not exited yet.| |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.| |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"}| |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".| +|gateway_address|string|Address (host:port) of gateway server.|Internal use only.| +|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.|| +|output_storage_classes|array of strings|The storage classes that will be used for the log and output collections of this container|| +|output_properties|hash|User metadata properties to set on the output collection.| +|cost|number|Estimated cost of the cloud VM used to run the container.|0 if not available.| +|subrequests_cost|number|Total estimated cumulative cost of container requests submitted by this container.|0 if not available.| h2(#container_states). Container states table(table table-bordered table-condensed). -|_. State|_. Sgnificance|_. Allowed next| +|_. State value|_. Description|_. Allowed next| |Queued|Waiting for a dispatcher to lock it and try to run the container.|Locked, Cancelled| |Locked|A dispatcher has "taken" the container and is allocating resources for it. The container has not started yet.|Queued, Running, Cancelled| |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| @@ -85,8 +91,9 @@ table(table table-bordered table-condensed). |error|string|The existance of this key indicates the container will definitely fail, or has already failed.|Optional.| |warning|string|Indicates something unusual happened or is currently happening, but isn't considered fatal.|Optional.| |activity|string|A message for the end user about what state the container is currently in.|Optional.| -|errorDetails|string|Additional structured error details.|Optional.| -|warningDetails|string|Additional structured warning details.|Optional.| +|errorDetail|string|Additional structured error details.|Optional.| +|warningDetail|string|Additional structured warning details.|Optional.| +|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.| h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %} @@ -98,10 +105,12 @@ Required arguments are displayed in %{background:#ccffcc}green%. Supports federated @get@ and @list@. -h2(#create). create +h3(#create). create Create a new Container. +This API requires admin privileges. In normal operation, it should not be used at all. + Arguments: table(table table-bordered table-condensed). @@ -110,7 +119,9 @@ table(table table-bordered table-condensed). h3. delete -Delete an existing Container. +Delete a Container. + +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. Arguments: @@ -134,8 +145,6 @@ List containers. See "common resource list method.":{{site.baseurl}}/api/methods.html#index -See the create method documentation for more information about Container-specific filters. - h3. update Update attributes of an existing Container.