doc/user/cwl/cwl-run-options.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "arvados-cwl-runner options"
   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 # "*Command line options*":#options
  13 # "*Specify workflow and output names*":#names
  14 # "*Submit a workflow without waiting for the result*":#nowait
  15 # "*Control a workflow locally*":#local
  16 # "*Automatically delete intermediate outputs*":#delete
  17 # "*Run workflow on a remote federated cluster*":#federation
  18
  19 h3(#options). Command line options
  20
  21 The following command line options are available for @arvados-cwl-runner@:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Option |_. Description |
  25 |==--basedir== BASEDIR|     Base directory used to resolve relative references in the input, default to directory of input object file or current directory (if inputs piped/provided on command line).|
  26 |==--eval-timeout EVAL_TIMEOUT==|Time to wait for a Javascript expression to evaluate before giving an error, default 20s.|
  27 |==--print-dot==|           Print workflow visualization in graphviz format and exit|
  28 |==--version==|             Print version and exit|
  29 |==--validate==|            Validate CWL document only.|
  30 |==--verbose==|             Default logging|
  31 |==--quiet==|               Only print warnings and errors.|
  32 |==--debug==|               Print even more logging|
  33 |==--metrics==|             Print timing metrics|
  34 |==--tool-help==|           Print command line help for tool|
  35 |==--enable-reuse==|        Enable container reuse (default)|
  36 |==--disable-reuse==|       Disable container reuse|
  37 |==--project-uuid UUID==|   Project that will own the workflow containers, if not provided, will go to home project.|
  38 |==--output-name OUTPUT_NAME==|Name to use for collection that stores the final output.|
  39 |==--output-tags OUTPUT_TAGS==|Tags for the final output collection separated by commas, e.g., =='--output-tags tag0,tag1,tag2'==.|
  40 |==--ignore-docker-for-reuse==|Ignore Docker image version when deciding whether to reuse past containers.|
  41 |==--submit==|              Submit workflow to run on Arvados.|
  42 |==--local==|               Run workflow on local host (submits containers to Arvados).|
  43 |==--create-template==|     (Deprecated) synonym for --create-workflow.|
  44 |==--create-workflow==|     Register an Arvados workflow that can be run from Workbench|
  45 |==--update-workflow== UUID|Update an existing Arvados workflow with the given UUID.|
  46 |==--wait==|                After submitting workflow runner, wait for completion.|
  47 |==--no-wait==|             Submit workflow runner and exit.|
  48 |==--log-timestamps==|      Prefix logging lines with timestamp|
  49 |==--no-log-timestamps==|   No timestamp on logging lines|
  50 |==--compute-checksum==|    Compute checksum of contents while collecting outputs|
  51 |==--submit-runner-ram== SUBMIT_RUNNER_RAM|RAM (in MiB) required for the workflow runner job (default 1024)|
  52 |==--submit-runner-image== SUBMIT_RUNNER_IMAGE|Docker image for workflow runner job|
  53 |==--always-submit-runner==|When invoked with --submit --wait, always submit a runner to manage the workflow, even when only running a single CommandLineTool|
  54 |==--match-submitter-images==|Where Arvados has more than one Docker image of the same name, use image from the Docker instance on the submitting node.|
  55 |==--submit-request-uuid== UUID|Update and commit to supplied container request instead of creating a new one.|
  56 |==--submit-runner-cluster== CLUSTER_ID|Submit workflow runner to a remote cluster|
  57 |==--collection-cache-size== COLLECTION_CACHE_SIZE|Collection cache size (in MiB, default 256).|
  58 |==--name== NAME|Name to use for workflow execution instance.|
  59 |==--on-error== {stop,continue}|Desired workflow behavior when a step fails.  One of 'stop' (do not submit any more steps) or 'continue' (may submit other steps that are not downstream from the error). Default is 'continue'.|
  60 |==--enable-dev==|Enable loading and running development versions of the CWL standards.|
  61 |==--storage-classes== STORAGE_CLASSES|Specify comma separated list of storage classes to be used when saving final workflow output to Keep.|
  62 |==--intermediate-storage-classes== INTERMEDIATE_STORAGE_CLASSES|Specify comma separated list of storage classes to be used when saving intermediate workflow output to Keep.|
  63 |==--intermediate-output-ttl== N|If N > 0, intermediate output collections will be trashed N seconds after creation. Default is 0 (don't trash).|
  64 |==--priority== PRIORITY|Workflow priority (range 1..1000, higher has precedence over lower)|
  65 |==--thread-count== THREAD_COUNT|Number of threads to use for job submit and output collection.|
  66 |==--http-timeout== HTTP_TIMEOUT|API request timeout in seconds. Default is 300 seconds (5 minutes).|
  67 |==--defer-downloads==|When submitting a workflow, defer downloading HTTP URLs to workflow launch instead of downloading to Keep before submit.|
  68 |==--varying-url-params== VARYING_URL_PARAMS|A comma separated list of URL query parameters that should be ignored when storing HTTP URLs in Keep.|
  69 |==--prefer-cached-downloads==|If a HTTP URL is found in Keep, skip upstream URL freshness check (will not notice if the upstream has changed, but also not error if upstream is unavailable).|
  70 |==--enable-preemptible==|Use preemptible instances. Control individual steps with arv:UsePreemptible hint.|
  71 |==--disable-preemptible==|Don't use preemptible instances.|
  72 |==--copy-deps==|         Copy dependencies into the destination project.|
  73 |==--no-copy-deps==|      Leave dependencies where they are.|
  74 |==--skip-schemas==|      Skip loading of schemas|
  75 |==--trash-intermediate==|Immediately trash intermediate outputs on workflow success.|
  76 |==--no-trash-intermediate==|Do not trash intermediate outputs (default).|
  77 |==--enable-usage-report==|Create usage_report.html with a summary of each step's resource usage.|
  78 |==--disable-usage-report==|Disable usage report.|
  79
  80 h3(#names). Specify workflow and output names
  81
  82 Use the @--name@ and @--output-name@ options to specify the name of the workflow and name of the output collection.
  83
  84 <notextile>
  85 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --name "Example bwa run" --output-name "Example bwa output" bwa-mem.cwl bwa-mem-input.yml</span>
  86 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
  87 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Upload local files: "bwa-mem.cwl"
  88 2016-06-30 14:56:36 arvados.arv-run[27002] INFO: Uploaded to zzzzz-4zz18-h7ljh5u76760ww2
  89 2016-06-30 14:56:40 arvados.cwl-runner[27002] INFO: Submitted job zzzzz-8i9sb-fm2n3b1w0l6bskg
  90 2016-06-30 14:56:41 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (zzzzz-8i9sb-fm2n3b1w0l6bskg) is Running
  91 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Job bwa-mem.cwl (zzzzz-8i9sb-fm2n3b1w0l6bskg) is Complete
  92 2016-06-30 14:57:12 arvados.cwl-runner[27002] INFO: Overall process status is success
  93 {
  94     "aligned_sam": {
  95         "path": "keep:54325254b226664960de07b3b9482349+154/HWI-ST1027_129_D0THKACXX.1_1.sam",
  96         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
  97         "class": "File",
  98         "size": 30738986
  99     }
 100 }
 101 </code></pre>
 102 </notextile>
 103
 104 h3(#nowait). Submit a workflow without waiting for the result
 105
 106 To submit a workflow and exit immediately, use the @--no-wait@ option.  This will submit the workflow to Arvados, print out the UUID of the job that was submitted to standard output, and exit.
 107
 108 <notextile>
 109 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --no-wait bwa-mem.cwl bwa-mem-input.yml</span>
 110 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 111 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Upload local files: "bwa-mem.cwl"
 112 2016-06-30 15:07:52 arvados.arv-run[12480] INFO: Uploaded to zzzzz-4zz18-eqnfwrow8aysa9q
 113 2016-06-30 15:07:52 arvados.cwl-runner[12480] INFO: Submitted job zzzzz-8i9sb-fm2n3b1w0l6bskg
 114 zzzzz-8i9sb-fm2n3b1w0l6bskg
 115 </code></pre>
 116 </notextile>
 117
 118 h3(#local). Control a workflow locally
 119
 120 To run a workflow with local control, use @--local@.  This means that the host where you run @arvados-cwl-runner@ will be responsible for submitting containers, however, the containers themselves will still run on the Arvados cluster.  With @--local@, if you interrupt @arvados-cwl-runner@ or log out, the workflow will be terminated.
 121
 122 <notextile>
 123 <pre><code>~/arvados/doc/user/cwl/bwa-mem$ <span class="userinput">arvados-cwl-runner --local bwa-mem.cwl bwa-mem-input.yml</span>
 124 arvados-cwl-runner 1.0.20160628195002, arvados-python-client 0.1.20160616015107, cwltool 1.0.20160629140624
 125 2016-07-01 10:05:19 arvados.cwl-runner[16290] INFO: Pipeline instance zzzzz-d1hrv-92wcu6ldtio74r4
 126 2016-07-01 10:05:28 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (zzzzz-8i9sb-2nzzfbuf9zjrj4g) is Queued
 127 2016-07-01 10:05:29 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (zzzzz-8i9sb-2nzzfbuf9zjrj4g) is Running
 128 2016-07-01 10:05:45 arvados.cwl-runner[16290] INFO: Job bwa-mem.cwl (zzzzz-8i9sb-2nzzfbuf9zjrj4g) is Complete
 129 2016-07-01 10:05:46 arvados.cwl-runner[16290] INFO: Overall process status is success
 130 {
 131     "aligned_sam": {
 132         "size": 30738986,
 133         "path": "keep:15f56bad0aaa7364819bf14ca2a27c63+88/HWI-ST1027_129_D0THKACXX.1_1.sam",
 134         "checksum": "sha1$0dc46a3126d0b5d4ce213b5f0e86e2d05a54755a",
 135         "class": "File"
 136     }
 137 }
 138 </code></pre>
 139 </notextile>
 140
 141 h3(#delete). Automatically delete intermediate outputs
 142
 143 Use the @--intermediate-output-ttl@ and @--trash-intermediate@ options to specify how long intermediate outputs should be kept (in seconds) and whether to trash them immediately upon successful workflow completion.
 144
 145 Temporary collections will be trashed @intermediate-output-ttl@ seconds after creation.  A value of zero (default) means intermediate output should be retained indefinitely.
 146
 147 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 for the entire the workflow.
 148
 149 Using @--trash-intermediate@ without @--intermediate-output-ttl@ means that intermediate files will be trashed on successful completion, but will remain on workflow failure.
 150
 151 Using @--intermediate-output-ttl@ without @--trash-intermediate@ means that intermediate files will be trashed only after the TTL expires (regardless of workflow success or failure).
 152
 153 h3(#federation). Run workflow on a remote federated cluster
 154
 155 By default, the workflow runner will run on the local (home) cluster.  Using @--submit-runner-cluster@ you can specify that the runner should be submitted to a remote federated cluster.  When doing this, @--project-uuid@ should specify a project on that cluster.  Steps making up the workflow will be submitted to the remote federated cluster by default, but the behavior of @arv:ClusterTarget@ is unchanged.  Note: when using this option, any resources that need to be uploaded in order to run the workflow (such as files or Docker images) will be uploaded to the local (home) cluster, and streamed to the federated cluster on demand.
 156
 157 h3(#preemptible). Using preemptible (spot) instances
 158
 159 Preemptible instances typically offer lower cost computation with a tradeoff of lower service guarantees.  If a compute node is preempted, Arvados will restart the computation on a new instance.
 160
 161 If the sitewide configuration @Containers.AlwaysUsePreemptibleInstances@ is true, workflow steps will always select preemptible instances, regardless of user option.
 162
 163 If @Containers.AlwaysUsePreemptibleInstances@ is false, you can request preemptible instances for a specific run with the @arvados-cwl-runner --enable-preemptible@ option.
 164
 165 Within the workflow, you can control whether individual steps should be preemptible with the "arv:UsePreemptible":cwl-extensions.html#UsePreemptible hint.
 166
 167 If a workflow requests preemptible instances with "arv:UsePreemptible":cwl-extensions.html#UsePreemptible , but you _do not_ want to use preemptible instances, you can override it for a specific run with the @arvados-cwl-runner --disable-preemptible@ option.
 168
 169 h3(#gpu). Use CUDA GPU instances
 170
 171 See "cwltool:CUDARequirement":cwl-extensions.html#CUDARequirement .