13681: Update documentation for arv:WorkflowRunnerResources

Also bring default allocation for cwl-runner launched by workbench in
line with a-c-r command line (1 GiB / 1 core).

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>

diff --git a/apps/workbench/app/controllers/work_units_controller.rb b/apps/workbench/app/controllers/work_units_controller.rb
index 0fe68476e3cdd6989870d1d3941de01f84d9a62e..a229654c36c84a52eca0a8338c15d1fd92659bf6 100644 (file)
--- a/apps/workbench/app/controllers/work_units_controller.rb
+++ b/apps/workbench/app/controllers/work_units_controller.rb
@@ -98,7 +98,7 @@ class WorkUnitsController < ApplicationController
       # runtime constriants
       runtime_constraints = {
         "vcpus" => 1,
-        "ram" => 256000000,
+        "ram" => 1024 * 1024 * 1024,
         "API" => true
       }
 

diff --git a/doc/user/cwl/cwl-extensions.html.textile.liquid b/doc/user/cwl/cwl-extensions.html.textile.liquid
index 26feb9938a5344e4d7b7f9a2363ee9bd8c0f9fff..f9ecf7a5343b6210ceaf613c796af535a114adb1 100644 (file)
--- a/doc/user/cwl/cwl-extensions.html.textile.liquid
+++ b/doc/user/cwl/cwl-extensions.html.textile.liquid
@@ -40,6 +40,9 @@ hints:
     secrets: [input1, input2]
   cwltool:TimeLimit:
     timelimit: 14400
+  arv:WorkflowRunnerResources:
+    ramMin: 2048
+    coresMin: 2
 </pre>
 
 The one exception to this is @arv:APIRequirement@, see note below.
@@ -114,6 +117,7 @@ table(table table-bordered table-condensed).
 |_. Field |_. Type |_. Description |
 |secrets|array<string>|Input parameters which are considered "secret".  Must be strings.|
 
+
 h2. cwltool:TimeLimit
 
 Set an upper limit on the execution time of a CommandLineTool or ExpressionTool.  A tool execution which exceeds the time limit may be preemptively terminated and considered failed.  May also be used by batch systems to make scheduling decisions.
@@ -121,3 +125,12 @@ Set an upper limit on the execution time of a CommandLineTool or ExpressionTool.
 table(table table-bordered table-condensed).
 |_. Field |_. Type |_. Description |
 |timelimit|int|Execution time limit in seconds. If set to zero, no limit is enforced.|
+
+h2. arv:WorkflowRunnerResources
+
+Specify resource requirements for the workflow runner process (arvados-cwl-runner) that manages a workflow run.  Must be applied to the top level workflow.  Will also be set implicitly when using @--submit-runner-ram@ on the command line along with @--create-workflow@ or @--update-workflow@.  Use this to adjust the runner's allocation if the workflow runner is getting "out of memory" exceptions or being killed by the out-of-memory (OOM) killer.
+
+table(table table-bordered table-condensed).
+|_. Field |_. Type |_. Description |
+|ramMin|int|RAM, in mebibytes, to reserve for the arvados-cwl-runner process. Default 1 GiB|
+|coresMin|int|Number of cores to reserve to the arvados-cwl-runner process. Default 1 core.|