Merge branch '21666-provision-test-improvement'
[arvados.git] / doc / api / methods / containers.html.textile.liquid
index c63bf4d11372a0356a92ec95211edb4d65118293..776d4098c5774153b576498b47bf2aabf7ead247 100644 (file)
@@ -30,9 +30,10 @@ table(table table-bordered table-condensed).
 |finished_at|datetime|When this container finished.|Null if container has not yet finished.|
 |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|
+|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.|
 |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.|
+|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.|
 |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.|
 |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".|
 |runtime_constraints|hash|Compute resources, and access to the outside world, that are / were available to the container.
@@ -97,6 +98,8 @@ table(table table-bordered table-condensed).
 
 h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %}
 
+h2(#glob_patterns). {% include 'container_glob_patterns' %}
+
 h2. Methods
 
 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
@@ -163,26 +166,3 @@ Get the api_client_authorization record indicated by this container's auth_uuid,
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string||path||
-
-h3. log
-
-Get container log data using WebDAV methods.
-
-This API retrieves data from the container's log collection. It can be used at any time in the container lifecycle.
-* While the container is @Queued@ or @Locked@ it returns an empty directory.
-* While the container is @Running@ it returns real-time logging data.
-* While the container is @Complete@ or @Cancelled@ it returns the final log collection.
-
-This API also supports the @Range@ request header, so it can be used to poll for and retrieve logs while the container is running.
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|method|string|Read-only WebDAV method|HTTP method|@GET@, @OPTIONS@, @PROPFIND@|
-{background:#ccffcc}.|uuid|string|The UUID of the Container in question.|path||
-|path|string|Path to a file in the log collection.|path|@/stderr.txt@|
-
-Examples:
-* @GET /arvados/v1/containers/zzzzz-dz642-0123456789abcde/log/stderr.txt@
-* @PROPFIND /arvados/v1/containers/zzzzz-dz642-0123456789abcde/log/@