19975: Add note about runtime.ram
authorPeter Amstutz <peter.amstutz@curii.com>
Tue, 7 Mar 2023 18:40:48 +0000 (13:40 -0500)
committerPeter Amstutz <peter.amstutz@curii.com>
Tue, 7 Mar 2023 18:40:48 +0000 (13:40 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

doc/user/cwl/cwl-extensions.html.textile.liquid

index 41a7d393d85ece91e2ef92c4035e423b91292923..ade588f148395fd0a7126d8a6d3d76ed2b289329 100644 (file)
@@ -195,7 +195,11 @@ table(table table-bordered table-condensed).
 
 h2(#OutOfMemoryRetry). arv:OutOfMemoryRetry
 
-Request that when a workflow step appears to have failed because it did not request enough RAM, it should be re-submitted with more RAM.  Out of memory conditions are detected either by the container being unexpectedly killed (exit code 137) or by matching a pattern in the container's output (see @memoryErrorRegex@).  Retrying will increase the base RAM request by the value of @memoryRetryMultipler@.  For example, if the original RAM request was 10 GiB and the multiplier is 1.5, then it will re-submit with 15 GiB.  Containers are only re-submitted once.  If it fails a second time after increasing RAM, then the worklow step will still fail.
+Request that when a workflow step appears to have failed because it did not request enough RAM, it should be re-submitted with more RAM.  Out of memory conditions are detected either by the container being unexpectedly killed (exit code 137) or by matching a pattern in the container's output (see @memoryErrorRegex@).  Retrying will increase the base RAM request by the value of @memoryRetryMultipler@.  For example, if the original RAM request was 10 GiB and the multiplier is 1.5, then it will re-submit with 15 GiB.
+
+Containers are only re-submitted once.  If it fails a second time after increasing RAM, then the worklow step will still fail.
+
+Also note that expressions that use @$(runtime.ram)@ (such as dynamic command line parameters) are not reevaluated when the container is resubmitted.
 
 table(table table-bordered table-condensed).
 |_. Field |_. Type |_. Description |