X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cfcfa1c48d95a07bb961baeef8d7658ddecce41e..bd703a2c3e59e0b419d6a4ac808ad30ffabde04d:/doc/user/tutorials/tutorial-keep-mount.html.textile.liquid diff --git a/doc/user/tutorials/tutorial-keep-mount.html.textile.liquid b/doc/user/tutorials/tutorial-keep-mount.html.textile.liquid index 43af024df2..f9e86cc177 100644 --- a/doc/user/tutorials/tutorial-keep-mount.html.textile.liquid +++ b/doc/user/tutorials/tutorial-keep-mount.html.textile.liquid @@ -3,8 +3,13 @@ layout: default navsection: userguide title: "Mounting Keep as a filesystem" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -This tutoral describes how to access Arvados collections using traditional filesystem tools by mounting Keep as a read-only file system using @arv-mount@. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +This tutoral describes how to access Arvados collections using traditional filesystem tools by mounting Keep as a file system using @arv-mount@. {% include 'tutorial_expectations' %} @@ -16,7 +21,7 @@ h2. Arv-mount * It is easy for existing tools to access files in Keep. * Data is streamed on demand. It is not necessary to download an entire file or collection to start processing. -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 their Keep locator. For instance, a collection may be found by its content hash in the @keep/by_id@ directory. +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.
~$ mkdir -p keep
@@ -33,11 +38,11 @@ var-GS000016015-ASM.tsv.bz2
 
 The last line unmounts Keep.  Subdirectories will no longer be accessible.
 
-Within each directory on Keep, there is a @.arvados#collection@ file that does not show up with @ls@. Its contents include, for instance, the @portable_data_hash@, which is the same as the Keep locator.
+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@.
 
 h3. Modifying files and directories in Keep
 
-By default, all files in the Keep mount are read only.  However, @arv-mount --enable-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:
+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:
 
 * Create, update, rename and delete individual files within collections
 * Create and delete subdirectories inside collections
@@ -53,4 +58,4 @@ Not supported:
 
 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~@.
 
-Please note this feature is in beta testing.  In particular, the conflict mechanism is itself currently subject to race condiditions with potential for data loss when a collection is being modified simultaneously by multiple clients.  This issue will be resolved in future development.
+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.