Merge branch 'master' into 10293-container-request-output-uuid

[arvados.git] / doc / api / execution.html.textile.liquid

diff --git a/doc/api/execution.html.textile.liquid b/doc/api/execution.html.textile.liquid
index f0578428d0c3195933d85dca7d2a2fa94a233ecf..900e7659ef2e1827004951c12f0dcdd9be2b4279 100644 (file)
--- a/doc/api/execution.html.textile.liquid
+++ b/doc/api/execution.html.textile.liquid
@@ -11,15 +11,17 @@ h2. Container API
 Note: although the preferred API for Aravdos going forward, the Container API may not yet be available on all installations.
 
 # To submit work, create a "container request":{{site.baseurl}}/api/methods/container_requests.html in the @Committed@ state.
-# The system will fufill the container request by creating a "Container object":{{site.baseurl}}/api/methods/containers.html or, if the same request has been submitted in the past, reusing an existing container.  This will be assigned to the @container_uuid@ field.
-# The dispatcher process will notice a new container in @Queued@ state and submit a container executor to the underyling work queuing system (such as SLURM).
+# The system will fufill the container request by creating or reusing a "Container object":{{site.baseurl}}/api/methods/containers.html and assigning it to the @container_uuid@ field.  If the same request has been submitted in the past, it may reuse an existing container.  The reuse behavior can be suppressed with @use_existing: false@ in the container request.
+# The dispatcher process will notice a new container in @Queued@ state and submit a container executor to the underlying work queuing system (such as SLURM).
 # The container executes.  Upon termination the container goes into the  @Complete@ state.  If the container execution was interrupted or lost due to system failure, it will go into the @Cancelled@ state.
 # When the container associated with the container request is completed, the container request will go into the @Final@ state.
-# Retrieve the container object; the @output@ field contains the portable data hash of collection with the output files of the container.
+# The @output_uuid@ field of the container request contains the uuid of output collection produced by container request.
+
+!{{site.baseurl}}/images/Crunch_dispatch.svg!
 
 h2. Job API (deprecated)
 
-# To submit work, create a "job":{{site.baseurl}}/api/methods/job.html .  If the same job has been submitted in the past, it will return an existing job in @Completed@ state.
+# To submit work, create a "job":{{site.baseurl}}/api/methods/jobs.html .  If the same job has been submitted in the past, it will return an existing job in @Completed@ state.
 # The dispatcher process will notice a new job in @Queued@ state and attempt to allocate nodes to run the job.
 # The job executes.
 # Retrieve the @output@ field with the portable data hash of the collection with the output files of the job.