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.
+Storage classes (sometimes called as "storage tiers") allow you to control which back-end storage volumes should be used to store the data blocks of a particular collection. This can be used to implement data storage policies such as assigning data collections to "fast", "robust" or "archival" storage.
-Desired storage classes are specified by setting the "storage_classes_desired" field of a Collection. For example, at the command line:
+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. Consult your cluster administrator for guidance on what storage classes are available to use on your specific Arvados instance.
+
+Note that when changing the storage class of an existing collection, it does not take effect immediately, the blocks are asynchronously copied to the new storage class and removed from the old one. The collection field "storage_classes_confirmed" is updated to reflect when data blocks have been successfully copied.
+
+h3. arv-put
+
+You may specify one or more desired storage classes for a collection uploaded using @arv-put@:
<pre>
-$ arv collection update --uuid zzzzz-4zz18-dhhm0ay8k8cqkvg --collection '{"storage_classes_desired": ["archival"]}'
+$ arv-put --storage-classes=hot,archival myfile.txt
</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.
+h3. arv-mount
-You may also specify the desired storage class when using @arv-put@:
+You can ask @arv-mount@ to use specific storage classes when creating new collections:
<pre>
-$ arv-put --storage-classes=hot myfile.txt
+$ arv-mount --storage-classes=transient --mount-tmp=scratch keep
</pre>
-Collection blocks will be in the "default" storage class if not otherwise specified.
+h3. arvados-cwl-runner
+
+You may specify the desired storage class for the intermediate and final output collections produced by @arvados-cwl-runner@ on the command line or using the "arv:OutputStorageClass hint":{{site.baseurl}}/user/cwl/cwl-extensions.html#OutputStorageClass .
+
+<pre>
+$ arvados-cwl-runner --intermediate-storage-classes=hot_storage --storage-classes=robust_storage myworkflow.cwl myinput.yml
+</pre>
+
+h3. arv command line
+
+You may set the storage class on an existing collection 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.
-A collection may have only specify one desired storage class.
+h3. Storage class notes
-A user with write access to a collection may set any storage class.
+Collection blocks will be in the cluster's configured default storage class(es) if not otherwise specified.
-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.
+Any user with write access to a collection may set any storage class on that collection.
projects / arvados.git / blobdiff