doc/user/cwl/federated-workflows.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Federated Multi-Cluster Workflows
   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 To support running analysis on geographically dispersed data (avoiding expensive data transfers by sending the computation to the data), and "hybrid cloud" configurations where an on-premise cluster can expand its capabilities by delegating work to a cloud-hosted cluster, Arvados supports federated workflows.  In a federated workflow, different steps of a workflow may execute on different clusters.  Arvados manages data transfer and delegation of credentials, so that all that is required is adding "arv:ClusterTarget":cwl-extensions.html#clustertarget hints to your existing workflow.
  13
  14 !(full-width)federated-workflow.svg!
  15
  16 For more information, visit the "architecture":{{site.baseurl}}/architecture/federation.html and "admin":{{site.baseurl}}/admin/federation.html sections about Arvados federation.
  17
  18 h2. Get the example files
  19
  20 The tutorial files are located in the "documentation section of the Arvados source repository:":https://github.com/arvados/arvados/tree/main/doc/user/cwl/federated or "see below":#fed-example
  21
  22 <notextile>
  23 <pre><code>~$ <span class="userinput">git clone https://github.com/arvados/arvados</span>
  24 ~$ <span class="userinput">cd arvados/doc/user/cwl/federated</span>
  25 </code></pre>
  26 </notextile>
  27
  28 h2. Run example
  29
  30 {% include 'notebox_begin' %}
  31
  32 At this time, remote steps of a workflow on Workbench are not displayed.  As a workaround, you can find the UUIDs of the remote steps in the live logs of the workflow runner (the "Logs" tab).  You may visit the remote cluster's workbench and enter the UUID into the search box to view the details of the remote step.  This will be fixed in a future version of workbench.
  33
  34 {% include 'notebox_end' %}
  35
  36 Run it like any other workflow:
  37
  38 <notextile>
  39 <pre><code>~$ <span class="userinput">arvados-cwl-runner feddemo.cwl shards.cwl</span>
  40 </code></pre>
  41 </notextile>
  42
  43 You can also "run a workflow on a remote federated cluster":cwl-run-options.html#federation .
  44
  45 h2(#fed-example). Federated scatter/gather example
  46
  47 In this following example, an analysis task is executed on three different clusters with different data, then the results are combined to produce the final output.
  48
  49 {% codeblock as yaml %}
  50 {% include 'federated_cwl' %}
  51 {% endcodeblock %}
  52
  53 Example input document:
  54
  55 {% codeblock as yaml %}
  56 {% include 'shards_yml' %}
  57 {% endcodeblock %}