doc/user/tutorials/tutorial-keep-mount.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Mounting Keep as a filesystem"
   5 ...
   6
   7 This tutoral describes how to access Arvados collections using traditional filesystem tools by mounting Keep as a read-only file system using @arv-mount@.
   8
   9 {% include 'tutorial_expectations' %}
  10
  11 h2. Arv-mount
  12
  13 @arv-mount@ provides several features:
  14
  15 * You can browse, open and read Keep entries as if they are regular files.
  16 * It is easy for existing tools to access files in Keep.
  17 * Data is streamed on demand.  It is not necessary to download an entire file or collection to start processing.
  18
  19 The default mode permits browsing any collection in Arvados as a subdirectory under the mount directory.  To avoid having to fetch a potentially large list of all collections, collection directories only come into existence when explicitly accessed by UUID or portable data hash. For instance, a collection may be found by its content hash in the @keep/by_id@ directory.
  20
  21 <notextile>
  22 <pre><code>~$ <span class="userinput">mkdir -p keep</span>
  23 ~$ <span class="userinput">arv-mount keep</span>
  24 ~$ <span class="userinput">cd keep/by_id/c1bad4b39ca5a924e481008009d94e32+210</span>
  25 ~/keep/by_id/c1bad4b39ca5a924e481008009d94e32+210$ <span class="userinput">ls</span>
  26 var-GS000016015-ASM.tsv.bz2
  27 ~/keep/by_id/c1bad4b39ca5a924e481008009d94e32+210$ <span class="userinput">md5sum var-GS000016015-ASM.tsv.bz2</span>
  28 44b8ae3fde7a8a88d2f7ebd237625b4f  var-GS000016015-ASM.tsv.bz2
  29 ~/keep/by_id/c1bad4b39ca5a924e481008009d94e32+210$ <span class="userinput">cd ../..</span>
  30 ~$ <span class="userinput">fusermount -u keep</span>
  31 </code></pre>
  32 </notextile>
  33
  34 The last line unmounts Keep.  Subdirectories will no longer be accessible.
  35
  36 In the top level directory of each collection, arv-mount provides a special file called @.arvados#collection@ that contains a JSON-formatted API record for the collection. This can be used to determine the collection's @portable_data_hash@, @uuid@, etc. This file does not show up in @ls@ or @ls -a@.
  37
  38 h3. Modifying files and directories in Keep
  39
  40 By default, all files in the Keep mount are read only.  However, @arv-mount --read-write@ enables you to perform the following operations using normal Unix command line tools (@touch@, @mv@, @rm@, @mkdir@, @rmdir@) and your own programs using standard POSIX file system APIs:
  41
  42 * Create, update, rename and delete individual files within collections
  43 * Create and delete subdirectories inside collections
  44 * Move files and directories within and between collections
  45 * Create and delete collections within a project (using @mkdir@ and @rmdir@ in a project directory)
  46
  47 Not supported:
  48
  49 * Symlinks, hard links
  50 * Changing permissions
  51 * Extended attributes
  52 * Moving a subdirectory of a collection into a project, or moving a collection from a project into another collection
  53
  54 If multiple clients (separate instances of arv-mount or other arvados applications) modify the same file in the same collection within a short time interval, this may result in a conflict.  In this case, the most recent commit wins, and the "loser" will be renamed to a conflict file in the form @name~YYYYMMDD-HHMMSS~conflict~@.
  55
  56 Please note this feature is in beta testing.  In particular, the conflict mechanism is itself currently subject to race conditions with potential for data loss when a collection is being modified simultaneously by multiple clients.  This issue will be resolved in future development.