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

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Arvados CWL Extensions
   5 ...
   6
   7 <pre>
   8 $namespaces:
   9   arv: "http://arvados.org/cwl#"
  10 hints:
  11   arv:RunInSingleContainer: {}
  12   arv:RuntimeConstraints:
  13     keep_cache: 123456
  14     keep_output_dir: local_output_dir
  15   arv:PartitionRequirement:
  16     partition: dev_partition
  17   arv:APIRequirement: {}
  18 </pre>
  19
  20 h2. arv:RunInSingleContainer
  21
  22 Indicates that a subworkflow should run in a single container and not be scheduled as separate steps.
  23
  24 h2. arv:RuntimeConstraints
  25
  26 Set Arvados-specific runtime hints.
  27
  28 |field|type|description|
  29 |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.|
  30 |outputDirType|enum|Preferred backing store for output staging.  If not specified, the system may choose which one to use.
  31
  32 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.
  33
  34 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.|
  35
  36 h2. arv:PartitionRequirement
  37
  38 Select preferred compute partitions on which to run jobs.
  39
  40 |field|type|description|
  41 |partition|string or array of string||
  42
  43 h2. arv:APIRequirement
  44
  45 Indicates that process wants to access to the Arvados API.  Will be granted limited network access and have ARVADOS_API_HOST and ARVADOS_API_TOKEN set in the environment.