13580: Add storage classes section to user guide

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

diff --git a/doc/_config.yml b/doc/_config.yml
index 17073347c1b5d523aa984cc9c07cdf6f9e2ecfd6..a64ff8aced868b7a3c6d6317268e5acdfa84d022 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -37,6 +37,7 @@ navbar:
       - user/tutorials/tutorial-keep-mount.html.textile.liquid
       - user/topics/keep.html.textile.liquid
       - user/topics/arv-copy.html.textile.liquid
+      - user/topics/storage-classes.html.textile.liquid
     - Running workflows at the command line:
       - user/cwl/cwl-runner.html.textile.liquid
       - user/cwl/cwl-run-options.html.textile.liquid
@@ -149,6 +150,7 @@ navbar:
       - admin/upgrading.html.textile.liquid
       - install/cheat_sheet.html.textile.liquid
       - user/topics/arvados-sync-groups.html.textile.liquid
+      - admin/storage-classes.html.textile.liquid
       - admin/migrating-providers.html.textile.liquid
       - admin/merge-remote-account.html.textile.liquid
       - install/migrate-docker19.html.textile.liquid

diff --git a/doc/admin/storage-classes.html.textile.liquid b/doc/admin/storage-classes.html.textile.liquid
index b518502c70ad50e5b356af5e3136896683d2059b..1a6420d4c48bfe5bbacfba10a72313bc53bec3ee 100644 (file)
--- a/doc/admin/storage-classes.html.textile.liquid
+++ b/doc/admin/storage-classes.html.textile.liquid
@@ -1,7 +1,7 @@
 ---
 layout: default
 navsection: admin
-title: Storage classes
+title: Configuring storage classes
 ...
 
 {% comment %}
@@ -12,8 +12,6 @@ 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.
 
-h3. Configuring storage classes
-
 The storage classes for each volume are set in the per-volume "keepstore configuration":{{site.baseurl}}/install/install-keepstore.html
 
 <pre>
@@ -36,25 +34,7 @@ Names of storage classes are internal to the cluster and decided by the administ
 
 h3. Using storage classes
 
-Desired storage classes are specified by setting the "storage_classes_desired" field of a Collection.  For example, at the command line:
-
-<pre>
-$ arv collection update --uuid zzzzz-4zz18-dhhm0ay8k8cqkvg --collection '{"storage_classes_desired": ["archival"]}'
-</pre>
-
-By setting "storage_classes_desired" to "archival", the blocks that make up the collection will be preferentially moved to keepstore volumes which are configured with the "archival" storage class.
-
-You may also specify the desired storage class when using @arv-put@:
-
-<pre>
-$ arv-put --storage-classes=hot myfile.txt
-</pre>
-
-Collection blocks will be in the "default" storage class if not otherwise specified.
-
-A collection may have only specify one desired storage class.
-
-A user with write access to a collection may set any storage class.
+"Discussed in the user guide":{{site.baseurl}}/user/topics/storage-classes.html
 
 h3. Storage management notes
 

diff --git a/doc/user/topics/storage-classes.html.textile.liquid b/doc/user/topics/storage-classes.html.textile.liquid
new file mode 100644 (file)
index 0000000..9ed7cf4
--- /dev/null
+++ b/doc/user/topics/storage-classes.html.textile.liquid
@@ -0,0 +1,35 @@
+---
+layout: default
+navsection: userguide
+title: Using storage classes
+...
+
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+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.
+
+Desired storage classes are specified by setting the "storage_classes_desired" field of a Collection.  For example, at the command line:
+
+<pre>
+$ arv collection update --uuid zzzzz-4zz18-dhhm0ay8k8cqkvg --collection '{"storage_classes_desired": ["archival"]}'
+</pre>
+
+By setting "storage_classes_desired" to "archival", the blocks that make up the collection will be preferentially moved to keepstore volumes which are configured with the "archival" storage class.
+
+You may also specify the desired storage class when using @arv-put@:
+
+<pre>
+$ arv-put --storage-classes=hot myfile.txt
+</pre>
+
+Collection blocks will be in the "default" storage class if not otherwise specified.
+
+A collection may have only specify one desired storage class.
+
+A user with write access to a collection may set any storage class.
+
+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.