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

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Arvados CWL Extensions
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 Arvados provides several extensions to CWL for workflow optimization, site-specific configuration, and to enable access the Arvados API.
  13
  14 To use Arvados CWL extensions, add the following @$namespaces@ section at the top of your CWL file:
  15
  16 <pre>
  17 $namespaces:
  18   arv: "http://arvados.org/cwl#"
  19   cwltool: "http://commonwl.org/cwltool#"
  20 </pre>
  21
  22 For portability, Arvados extensions should go into the @hints@ section of your CWL file, for example:
  23
  24 <pre>
  25 hints:
  26   arv:RunInSingleContainer: {}
  27   arv:RuntimeConstraints:
  28     keep_cache: 123456
  29     outputDirType: keep_output_dir
  30   arv:PartitionRequirement:
  31     partition: dev_partition
  32   arv:APIRequirement: {}
  33   cwltool:LoadListingRequirement:
  34     loadListing: shallow_listing
  35   arv:IntermediateOutput:
  36     outputTTL: 3600
  37   arv:ReuseRequirement:
  38     enableReuse: false
  39   cwltool:Secrets:
  40     secrets: [input1, input2]
  41   cwltool:TimeLimit:
  42     timelimit: 14400
  43   arv:WorkflowRunnerResources:
  44     ramMin: 2048
  45     coresMin: 2
  46   arv:ClusterTarget:
  47     cluster_id: clsr1
  48     project_uuid: clsr1-j7d0g-qxc4jcji7n4lafx
  49 </pre>
  50
  51 The one exception to this is @arv:APIRequirement@, see note below.
  52
  53 h2. arv:RunInSingleContainer
  54
  55 Indicates that a subworkflow should run in a single container and not be scheduled as separate steps.
  56
  57 h2. arv:RuntimeConstraints
  58
  59 Set Arvados-specific runtime hints.
  60
  61 table(table table-bordered table-condensed).
  62 |_. Field |_. Type |_. Description |
  63 |keep_cache|int|Size of file data buffer for Keep mount in MiB. Default is 256 MiB. Increase this to reduce cache thrashing in situations such as accessing multiple large (64+ MiB) files at the same time, or performing random access on a large file.|
  64 |outputDirType|enum|Preferred backing store for output staging.  If not specified, the system may choose which one to use.  One of *local_output_dir* or *keep_output_dir*|
  65
  66 *local_output_dir*: Use regular file system local to the compute node. There must be sufficient local scratch space to store entire output; specify this with @outdirMin@ of @ResourceRequirement@.  Files are batch uploaded to Keep when the process completes.  Most compatible, but upload step can be time consuming for very large files.
  67
  68 *keep_output_dir*: Use writable Keep mount.  Files are streamed to Keep as they are written.  Does not consume local scratch space, but does consume RAM for output buffers (up to 192 MiB per file simultaneously open for writing.)  Best suited to processes which produce sequential output of large files (non-sequential writes may produced fragmented file manifests).  Supports regular files and directories, does not support special files such as symlinks, hard links, named pipes, named sockets, or device nodes.|
  69
  70 h2. arv:PartitionRequirement
  71
  72 Select preferred compute partitions on which to run jobs.
  73
  74 table(table table-bordered table-condensed).
  75 |_. Field |_. Type |_. Description |
  76 |partition|string or array of strings||
  77
  78 h2. arv:APIRequirement
  79
  80 Indicates that process wants to access to the Arvados API.  Will be granted network access and have @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ set in the environment.  Tools which rely on the Arvados API being present should put @arv:APIRequirement@ in the @requirements@ section of the tool (rather than @hints@) to indicate that that it is not portable to non-Arvados CWL runners.
  81
  82 Use @arv:APIRequirement@ in @hints@ to enable general (non-Arvados-specific) network access for a tool.
  83
  84 h2. cwltool:LoadListingRequirement
  85
  86 In CWL v1.0 documents, the default behavior for Directory objects is to recursively expand the @listing@ for access by parameter references an expressions.  For directory trees containing many files, this can be expensive in both time and memory usage.  Use @cwltool:LoadListingRequirement@ to change the behavior for expansion of directory listings in the workflow runner.
  87
  88 table(table table-bordered table-condensed).
  89 |_. Field |_. Type |_. Description |
  90 |loadListing|string|One of @no_listing@, @shallow_listing@, or @deep_listing@|
  91
  92 *no_listing*: Do not expand directory listing at all.  The @listing@ field on the Directory object will be undefined.
  93
  94 *shallow_listing*: Only expand the first level of directory listing.  The @listing@ field on the toplevel Directory object will contain the directory contents, however @listing@ will not be defined on subdirectories.
  95
  96 *deep_listing*: Recursively expand all levels of directory listing.  The @listing@ field will be provided on the toplevel object and all subdirectories.
  97
  98 h2. arv:IntermediateOutput
  99
 100 Specify desired handling of intermediate output collections.
 101
 102 table(table table-bordered table-condensed).
 103 |_. Field |_. Type |_. Description |
 104 |outputTTL|int|If the value is greater than zero, consider intermediate output collections to be temporary and should be automatically trashed. Temporary collections will be trashed @outputTTL@ seconds after creation.  A value of zero means intermediate output should be retained indefinitely (this is the default behavior).
 105 Note: arvados-cwl-runner currently does not take workflow dependencies into account when setting the TTL on an intermediate output collection. If the TTL is too short, it is possible for a collection to be trashed before downstream steps that consume it are started.  The recommended minimum value for TTL is the expected duration of the entire the workflow.|
 106
 107 h2. arv:ReuseRequirement
 108
 109 Enable/disable work reuse for current process.  Default true (work reuse enabled).
 110
 111 table(table table-bordered table-condensed).
 112 |_. Field |_. Type |_. Description |
 113 |enableReuse|boolean|Enable/disable work reuse for current process.  Default true (work reuse enabled).|
 114
 115 h2. cwltool:Secrets
 116
 117 Indicate that one or more input parameters are "secret".  Must be applied at the top level Workflow.  Secret parameters are not stored in keep, are hidden from logs and API responses, and are wiped from the database after the workflow completes.
 118
 119 table(table table-bordered table-condensed).
 120 |_. Field |_. Type |_. Description |
 121 |secrets|array<string>|Input parameters which are considered "secret".  Must be strings.|
 122
 123
 124 h2. cwltool:TimeLimit
 125
 126 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.
 127
 128 table(table table-bordered table-condensed).
 129 |_. Field |_. Type |_. Description |
 130 |timelimit|int|Execution time limit in seconds. If set to zero, no limit is enforced.|
 131
 132 h2. arv:WorkflowRunnerResources
 133
 134 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.
 135
 136 table(table table-bordered table-condensed).
 137 |_. Field |_. Type |_. Description |
 138 |ramMin|int|RAM, in mebibytes, to reserve for the arvados-cwl-runner process. Default 1 GiB|
 139 |coresMin|int|Number of cores to reserve to the arvados-cwl-runner process. Default 1 core.|
 140
 141 h2(#clustertarget). arv:ClusterTarget
 142
 143 Specify which Arvados cluster should execute a container or subworkflow, and the parent project for the container request.
 144
 145 table(table table-bordered table-condensed).
 146 |_. Field |_. Type |_. Description |
 147 |cluster_id|string|The five-character alphanumeric cluster id (uuid prefix) where a container or subworkflow will execute.  May be an expression.|
 148 |project_uuid|string|The uuid of the project which will own container request and output of the container.  May be an expression.|