[ARVADOS] updated: 2.1.0-1167-g2de3b2e44

Git user git at public.arvados.org
Fri Aug 6 14:20:28 UTC 2021


Summary of changes:
 doc/admin/storage-classes.html.textile.liquid      | 29 +++++++++++++++++++---
 .../topics/storage-classes.html.textile.liquid     |  6 ++---
 2 files changed, 28 insertions(+), 7 deletions(-)

       via  2de3b2e44f2196c227c7bbd57b211d1095e59aad (commit)
      from  13b280ea288fd08e8c77300b087037635d739eaa (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit 2de3b2e44f2196c227c7bbd57b211d1095e59aad
Author: Tom Clegg <tom at curii.com>
Date:   Fri Aug 6 10:19:59 2021 -0400

    17967: Update storage classes docs.
    
    Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at curii.com>

diff --git a/doc/admin/storage-classes.html.textile.liquid b/doc/admin/storage-classes.html.textile.liquid
index 3e17831b5..ade963387 100644
--- a/doc/admin/storage-classes.html.textile.liquid
+++ b/doc/admin/storage-classes.html.textile.liquid
@@ -12,21 +12,44 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 
 Storage classes (alternately known as "storage tiers") allow you to control which volumes should be used to store particular collection data blocks.  This can be used to implement data storage policies such as moving data to archival storage.
 
-The storage classes for each volume are set in the per-volume "keepstore configuration":{{site.baseurl}}/install/install-keepstore.html
+In the default Arvados configuration, with no storage classes specified in the configuration file, all volumes belong to a single implicit storage class called "default". Apart from that, names of storage classes are internal to the cluster and decided by the administrator.  Other than the implicit "default" class, Arvados currently does not define any standard storage class names.
+
+To use multiple storage classes, update the @StorageClasses@ and @Volumes@ sections of your configuration file.
+* Every storage class you use (including "default") must be defined in the @StorageClasses@ section.
+* The @StorageClasses@ section must use @Default: true@ to indicate at least one default storage class. When a client/user does not specify storage classes when creating a new collection, the default storage classes are used implicitly.
+* If some storage classes are faster or cheaper to access than others, assign a higher @Priority@ to the faster ones. When reading data, volumes with high priority storage classes are searched first.
+
+Example:
 
 <pre>
+    StorageClasses:
+
+      default:
+        # When reading a block that is stored on multiple volumes,
+        # prefer a volume with this class.
+        Priority: 20
+
+        # When a client does not specify a storage class when saving a
+        # new collection, use this one.
+        Default: true
+
+      archival:
+        Priority: 10
+
     Volumes:
+
       ClusterID-nyw5e-000000000000000:
         # This volume is in the "default" storage class.
         StorageClasses:
           default: true
+
       ClusterID-nyw5e-000000000000001:
-        # Specify this volume is in the "archival" storage class.
+        # This volume is in the "archival" storage class.
         StorageClasses:
           archival: true
 </pre>
 
-Names of storage classes are internal to the cluster and decided by the administrator.  Aside from "default", Arvados currently does not define any standard storage class names.
+Refer to the "configuration reference":{{site.baseurl}}/admin/config.html for more details.
 
 h3. Using storage classes
 
diff --git a/doc/user/topics/storage-classes.html.textile.liquid b/doc/user/topics/storage-classes.html.textile.liquid
index 99556af10..650c37095 100644
--- a/doc/user/topics/storage-classes.html.textile.liquid
+++ b/doc/user/topics/storage-classes.html.textile.liquid
@@ -38,7 +38,7 @@ You may also specify the desired storage class for the final output collection p
 $ arvados-cwl-runner --storage-classes=hot myworkflow.cwl myinput.yml
 </pre>
 
-(Note: intermediate collections produced by a workflow run will have "default" storage class.)
+(Note: intermediate collections produced by a workflow run will use the cluster's default storage class(es).)
 
 h3. arv command line
 
@@ -52,8 +52,6 @@ By setting "storage_classes_desired" to "archival", the blocks that make up the
 
 h3. Storage class notes
 
-Collection blocks will be in the "default" storage class if not otherwise specified.
+Collection blocks will be in the cluster's configured default storage class(es) if not otherwise specified.
 
 Any user with write access to a collection may set any storage class on that collection.
-
-Names of storage classes are internal to the cluster and decided by the administrator.  Aside from "default", Arvados currently does not define any standard storage class names.

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list