doc/user/topics/storage-classes.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Using storage classes
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 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.
  14
  15 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.
  16
  17 h3. arv-put
  18
  19 You may specify one or more desired storage classes for a collection uploaded using @arv-put@:
  20
  21 <pre>
  22 $ arv-put --storage-classes=hot,archival myfile.txt
  23 </pre>
  24
  25 h3. arv-mount
  26
  27 You can ask @arv-mount@ to use specific storage classes when creating new collections:
  28
  29 <pre>
  30 $ arv-mount --storage-classes=transient --mount-tmp=scratch keep
  31 </pre>
  32
  33 h3. arvados-cwl-runner
  34
  35 You may also specify the desired storage class for the final output collection produced by @arvados-cwl-runner@:
  36
  37 <pre>
  38 $ arvados-cwl-runner --storage-classes=hot myworkflow.cwl myinput.yml
  39 </pre>
  40
  41 (Note: intermediate collections produced by a workflow run will use the cluster's default storage class(es).)
  42
  43 h3. arv command line
  44
  45 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:
  46
  47 <pre>
  48 $ arv collection update --uuid zzzzz-4zz18-dhhm0ay8k8cqkvg --collection '{"storage_classes_desired": ["archival"]}'
  49 </pre>
  50
  51 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.
  52
  53 h3. Storage class notes
  54
  55 Collection blocks will be in the cluster's configured default storage class(es) if not otherwise specified.
  56
  57 Any user with write access to a collection may set any storage class on that collection.