14440: Federated workflow docs WIP

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

diff --git a/doc/_includes/_federated_cwl.liquid b/doc/_includes/_federated_cwl.liquid
new file mode 120000 (symlink)
index 0000000..59a629c
--- /dev/null
+++ b/doc/_includes/_federated_cwl.liquid
@@ -0,0 +1 @@
+../user/cwl/federated/federated.cwl
\ No newline at end of file

diff --git a/doc/_includes/_shards_yml.liquid b/doc/_includes/_shards_yml.liquid
new file mode 120000 (symlink)
index 0000000..99ae31c
--- /dev/null
+++ b/doc/_includes/_shards_yml.liquid
@@ -0,0 +1 @@
+../user/cwl/federated/shards.yml
\ No newline at end of file

diff --git a/doc/user/cwl/federated-workflows.html.textile.liquid b/doc/user/cwl/federated-workflows.html.textile.liquid
index a692bf4fff866eedde23d39b607c92abb53943a6..754011f467e391eeb07742a25db8ae27b82d134a 100644 (file)
--- a/doc/user/cwl/federated-workflows.html.textile.liquid
+++ b/doc/user/cwl/federated-workflows.html.textile.liquid
@@ -9,12 +9,14 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-Arvados supports federated workflows, where different step of a running workflow execute on different clusters.  This supports running analysis on geographically dispersed data (avoiding expensive data transfers by sending the computation to the data) or in "hybrid cloud" configurations where an on-premise cluster can expand its capabilities by sending work to a cloud-base cluster.
+Arvados supports federated workflows, where different steps of a running workflow may execute on different clusters.  Arvados manages data transfer and delegation of credentials, so this as easy as simply adding cluster target hints to your existing workflow.  This supports 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-base cluster.
 
 h2. Federated scatter/gather example
 
-<pre>
-</pre>
+{% codeblock as yaml %}
+{% include 'federated_cwl' %}
+{% endcodeblock %}
 
-<pre>
-</pre>
+{% codeblock as yaml %}
+{% include 'shards_yml' %}
+{% endcodeblock %}

diff --git a/doc/user/cwl/federated/federated.cwl b/doc/user/cwl/federated/federated.cwl
index 6c58997a0b4b732f7eea3e7ad897a12d8d96d958..401acc5454651f3b4070aa5b7755019e9fdd3f56 100644 (file)
--- a/doc/user/cwl/federated/federated.cwl
+++ b/doc/user/cwl/federated/federated.cwl
@@ -7,6 +7,7 @@ requirements:
   DockerRequirement:
     dockerPull: arvados/fed-test:scatter-gather
   ScatterFeatureRequirement: {}
+  StepInputExpressionRequirement: {}
   SchemaDefRequirement:
     types:
       - name: FileOnCluster

diff --git a/doc/user/cwl/federated/file-on-clsr1.dat b/doc/user/cwl/federated/file-on-clsr1.dat
new file mode 100644 (file)
index 0000000..e79f152
--- /dev/null
+++ b/doc/user/cwl/federated/file-on-clsr1.dat
@@ -0,0 +1 @@
+file-on-clsr1.dat

diff --git a/doc/user/cwl/federated/file-on-clsr2.dat b/doc/user/cwl/federated/file-on-clsr2.dat
new file mode 100644 (file)
index 0000000..9179dc8
--- /dev/null
+++ b/doc/user/cwl/federated/file-on-clsr2.dat
@@ -0,0 +1 @@
+file-on-clsr2.dat

diff --git a/doc/user/cwl/federated/file-on-clsr3.dat b/doc/user/cwl/federated/file-on-clsr3.dat
new file mode 100644 (file)
index 0000000..58b5902
--- /dev/null
+++ b/doc/user/cwl/federated/file-on-clsr3.dat
@@ -0,0 +1 @@
+file-on-clsr3.dat

diff --git a/doc/user/cwl/federated/shards.yml b/doc/user/cwl/federated/shards.yml
index 1ca4f2e3f659c15442802af4f188ceaa2dcaddbc..e0f548785625f2d03242ea90aa7ebb0f002f29ac 100644 (file)
--- a/doc/user/cwl/federated/shards.yml
+++ b/doc/user/cwl/federated/shards.yml
@@ -2,12 +2,14 @@ shards:
   - cluster: clsr1
     file:
       class: File
-      location: file-on-clsr1.dat
+      location: keep:485df2c5cec3207a32f49c42f1cdcca9+61/file-on-clsr1.dat
+
   - cluster: clsr2
     file:
       class: File
-      location: file-on-clsr2.dat
+      location: keep:ae6e9c3e9bfa52a0122ecb489d8198ff+61/file-on-clsr2.dat
+
   - cluster: clsr3
     file:
       class: File
-      location: file-on-clsr3.dat
+      location: keep:0b43a0ef9ea592d5d7b299978dfa8643+61/file-on-clsr3.dat