14440: Add discussion of federation features.

[arvados.git] / doc / user / tutorials / tutorial-keep-get.html.textile.liquid

diff --git a/doc/user/tutorials/tutorial-keep-get.html.textile.liquid b/doc/user/tutorials/tutorial-keep-get.html.textile.liquid
index 4d9c04779bbcafdade31be5964d67ef7e6d199ef..f206d302dee334c1287cae1f41c5dee6009fdbe1 100644 (file)
--- a/doc/user/tutorials/tutorial-keep-get.html.textile.liquid
+++ b/doc/user/tutorials/tutorial-keep-get.html.textile.liquid
@@ -3,10 +3,21 @@ layout: default
 navsection: userguide
 title: "Downloading data"
 ...
 navsection: userguide
 title: "Downloading data"
 ...

+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.

 
 

-{% include 'tutorial_expectations' %}
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+Arvados Data collections can be downloaded using either the arv commands or using Workbench.
+
+# "*Downloading using arv commands*":#download-using-arv
+# "*Downloading using Workbench*":#download-using-workbench
+# "*Downloading a shared collection using Workbench*":#download-shared-collection
+
+h2(#download-using-arv). Downloading using arv commands

 
 

-h2. Downloading using arv commands
+{% include 'tutorial_expectations' %}

 
 You can download Arvados data collections using the command line tools @arv-ls@ and @arv-get@.
 
 
 You can download Arvados data collections using the command line tools @arv-ls@ and @arv-get@.
 


@@ -48,7 +59,20 @@ You can also download individual files:
 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-h2. Downloading using Workbench
+h3. Federated downloads
+
+If your cluster is "configured to be part of a federation":{{site.baseurl}}/admin/federation.html you can also download collections hosted on other clusters (with appropriate permissions).
+
+If you request a collection by portable data hash, it will first search the home cluster, then search federated clusters.
+
+You may also request a collection by UUID.  In this case, it will contact the cluster named in the UUID prefix (in this example, @qr1hi@).
+
+<notextile>
+<pre><code>~$ <span class="userinput">arv-get qr1hi-4zz18-fw6dnjxtkvzdewt/ .</span>
+</code></pre>
+</notextile>
+
+h2(#download-using-workbench). Downloading using Workbench

 
 You can also download Arvados data collections using the Workbench.
 
 
 You can also download Arvados data collections using the Workbench.
 


@@ -56,20 +80,18 @@ Visit the Workbench *Dashboard*. Click on *Projects*<span class="caret"></span>
 
 You can access the contents of a collection by clicking on the *<i class="fa fa-fw fa-archive"></i> Show* button next to the collection. This will take you to the collection's page. Using this page you can see the collection's contents, download individual files, and set sharing options.
 
 
 You can access the contents of a collection by clicking on the *<i class="fa fa-fw fa-archive"></i> Show* button next to the collection. This will take you to the collection's page. Using this page you can see the collection's contents, download individual files, and set sharing options.
 

-You can now download the collection by clicking on the <span class="btn btn-sm btn-info"><i class="fa fa-download"></i></span> button.
+You can now download the collection files by clicking on the <span class="btn btn-sm btn-info"><i class="fa fa-download"></i></span> button(s).

 
 

-h2. Downloading a shared collection using Workbench
+h2(#download-shared-collection). Downloading a shared collection using Workbench

 
 Collections can be shared to allow downloads by anonymous users.
 
 
 Collections can be shared to allow downloads by anonymous users.
 

-To share a collection with anonymous users, visit the collections page using Workbench as described in the above section. Once on the collection's page, click on the <span class="btn btn-sm btn-primary" >Create sharing link</span> button.
+To share a collection with anonymous users, visit the collection page using Workbench as described in the above section. Once on this page, click on the <span class="btn btn-sm btn-primary" >Create sharing link</span> button.

 
 This will create a sharing link for the collection as shown below. You can copy the sharing link in this page and share it with other users.
 
 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/shared-collection.png!
 
 
 This will create a sharing link for the collection as shown below. You can copy the sharing link in this page and share it with other users.
 
 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/shared-collection.png!
 

-A user with this url can download this collection by simply accessing this url. It will present a downloadable version of the collection as shown below.
+A user with this url can download this collection by simply accessing this url using browser. It will present a downloadable version of the collection as shown below.

 
 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/download-shared-collection.png!
 
 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/download-shared-collection.png!

-
-