Arvados

h1. Keep storage groups

h2. Use cases

* Partition data among several cloud buckets for legal or financial reasons.

* Shift data from "hot" to "cool" storage (e.g. SSD to disk) for price/performance tradeoff.

* Move data from on-line to off-line storage (e.g. Glacier) but maintain provenance.

h2. Requirements

* arv-put has option to specify storage group.

** When writing each block, client can specify storage group for the block.

** Use API to specify that the blocks belonging to a collection should go into a certain storage group.

* Workbench permits changing storage group on a collection

* arvados-cwl-runner has options to specify storage groups for intermediate and final output collections.

** Use API to specify the storage group for the output collection of a container request.

* TBD: access controls on storage groups, can restrict which users can place collections in which storage group?

h2. Design

A "storage group" is effectively a tagging scheme to specify a group of keep servers (& volumes/mounts of a keep server) where a block should be preferentially stored.

Generalized from [[Keep storage tiers]] (but unlike storage tiers proposal, there is no implied price/performance relationship between groups).

Each keepstore service has access to one or more storage groups.  Storage groups are independent.  Data assigned to a group may still be sharded among multiple servers.  Groups are be identified with labels or uuids instead of integers.  The keep services table adds a column which lists which groups are available at which services.

When writing blocks, keepstore recognizes a header @X-Keep-Storage-Group@ and accepts or denies the block based on whether it can place the block in the designated group.  If not supplied, keepstores should have a default pool.  The value of @X-Keep-Storage-Group@ should be reported in the response.

Each keepstore volume (mount) is associated with a storage group.

Collections may specify a desired group for the blocks in the collection.  Keep balance should move blocks to the desired group.  If multiple collections reference the same block in different group, each group should have a copy with full replication.

Data management policies, such as "move data from hot storage to cool storage after 1 month", should be implemented  on top of the keepstore layer with additional tooling/scripts that set storage groups on collections.

Storage groups could be used for moving data into long-term storage (e.g. Glacier, tape backup, etc).  As an example, the user would change the storage group to "glacier", which would copy the blocks into offline storage and delete them from the online storage.  To retrieve the blocks, the user would change the storage group to "s3".  This would fetch the blocks and copy them back to online storage.  (TBD: how does the client find out when the data actually becomes available.)

h2. Development tasks

# keepstore: configurable group per volume/mount

# keepstore: support x-keep-storage-group header

# apiserver: collections.desired_storage_group column, site default group (probably called "default")

# keep-balance: compute/report desired storage group(s) for each block