X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e59b78c774872e33b9c69acc196989a0f565bdf4..002aec2a7db39d269bb3c9123783022c2e32a5cc:/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 f0ce8e362f..8a7ebc36e5 100644 --- a/doc/api/methods/containers.html.textile.liquid +++ b/doc/api/methods/containers.html.textile.liquid @@ -65,9 +65,11 @@ table(table table-bordered table-condensed). |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| -|Complete|Container was running, and the contained process/command has exited.|-| +|Complete|Container was running, and the contained process/command has exited.|Cancelled| |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).|-| +See "Controlling container reuse":{{site.baseurl}}/admin/controlling-container-reuse.html for details about changing state from @Complete@ to @Cancelled@ + h2(#mount_types). {% include 'mount_types' %} h2(#runtime_constraints). {% include 'container_runtime_constraints' %} @@ -108,7 +110,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: @@ -132,8 +136,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.