12573: Clarify docs.
authorPeter Amstutz <pamstutz@veritasgenetics.com>
Mon, 4 Dec 2017 19:55:19 +0000 (14:55 -0500)
committerPeter Amstutz <pamstutz@veritasgenetics.com>
Mon, 4 Dec 2017 19:55:19 +0000 (14:55 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>

doc/_includes/_container_scheduling_parameters.liquid
doc/api/methods/container_requests.html.textile.liquid
doc/api/methods/containers.html.textile.liquid

index d8f497125141a10ef36a0dca68cedce9bc4d284f..6eee4e0447c9715c3f88e3da07e003124ad8f001 100644 (file)
@@ -11,17 +11,3 @@ Parameters to be passed to the container scheduler (e.g., SLURM) when running a
 table(table table-bordered table-condensed).
 |_. Key|_. Type|_. Description|_. Notes|
 |partitions|array of strings|The names of one or more compute partitions that may run this container. If not provided, the system will choose where to run the container.|Optional.|
-
-h2(#priority). Priority
-
-The @priority@ field has a range of 0-1000.
-
-Priority 0 means no container should run on behalf of this request, and containers already running will be terminated (setting container priority to 0 is the cancel operation.)
-
-Priority 1 is the lowest priority.
-
-Priority 1000 is the highest priority.
-
-The actual order that containers execute is determined by the underlying scheduling software (e.g. SLURM) based on a combination of container priority, submission time and available resources.
-
-The magnitude of difference in priority between two containers affects the weight of priority vs age in determining scheduling order.  If two containers have only a small difference in priority (for example, 500 and 501) and the lower priority container has a longer queue time, the lower priority container may be scheduled before the higher priority container.  Use a greater magnitude difference (for example, 500 and 600) to give higher weight to priority over queue time.
index 8b9a393b417d737873af6187e46c0cc709edd496..1c2550f723f5d8d96241ff12b9d5c09cf136e512 100644 (file)
@@ -57,6 +57,20 @@ table(table table-bordered table-condensed).
 |output_uuid|string|Output collection created when the container finished successfully.|Null if the container has failed or not yet completed.|
 |filters|string|Additional constraints for satisfying the container_request, given in the same form as the filters parameter accepted by the container_requests.list API.|
 
+h2(#priority). Priority
+
+The @priority@ field has a range of 0-1000.
+
+Priority 0 means no container should run on behalf of this request, and containers already running will be terminated (setting container priority to 0 is the cancel operation.)
+
+Priority 1 is the lowest priority.
+
+Priority 1000 is the highest priority.
+
+The actual order that containers execute is determined by the underlying scheduling software (e.g. SLURM) and may be based on a combination of container priority, submission time, available resources, and other factors.
+
+In the current implementation, the magnitude of difference in priority between two containers affects the weight of priority vs age in determining scheduling order.  If two containers have only a small difference in priority (for example, 500 and 501) and the lower priority container has a longer queue time, the lower priority container may be scheduled before the higher priority container.  Use a greater magnitude difference (for example, 500 and 600) to give higher weight to priority over queue time.
+
 h2(#mount_types). {% include 'mount_types' %}
 
 h2(#runtime_constraints). {% include 'container_runtime_constraints' %}
index e82016f60ac483a7f35428f52dcf774e588e63b6..30ec055a6bbb61fb1e0c2051f50b4c4f41b8a836 100644 (file)
@@ -47,7 +47,7 @@ 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.|Assigned by the system as the max() of the priorities of all associated ContainerRequests.  See "below for more details":#priority .|
+|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"|
 |auth_uuid|string|UUID of a token to be passed into the container itself, used to access Keep-backed mounts, etc.|Null if state∉{"Locked","Running"}|
 |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"}|