--- layout: default navsection: installguide title: Install Keepstore servers ... {% comment %} Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 {% endcomment %} # "Introduction":#introduction # "Update config.yml":#update-config # "Install keepstore package":#install-packages # "Restart the API server and controller":#restart-api # "Confirm working installation":#confirm-working h2. Introduction Keepstore provides access to underlying storage for reading and writing content-addressed blocks, with enforcement of Arvados permissions. Keepstore supports a variety of cloud object storage and POSIX filesystems for its backing store. h3. Plan your storage layout In the steps below, you will configure a number of backend storage volumes (like local filesystems and S3 buckets) and specify which keepstore servers have read-only and read-write access to which volumes. It is possible to configure arbitrary server/volume layouts. However, in order to provide good performance and efficient use of storage resources, we strongly recommend using one of the following layouts: # Each volume is writable by exactly one server, and optionally readable by one or more other servers. The total capacity of all writable volumes is the same for each server. # Each volume is writable by all servers. Each volume has enough built-in redundancy to satisfy your requirements, i.e., you do not need Arvados to mirror data across multiple volumes. We recommend starting off with two Keepstore servers. Exact server specifications will be site and workload specific, but in general keepstore will be I/O bound and should be set up to maximize aggregate bandwidth with compute nodes. To increase capacity (either space or throughput) it is straightforward to add additional servers, or (in cloud environments) to increase the machine size of the existing servers. By convention, we use the following hostname pattern:
Services:
Keepstore:
# No ExternalURL because they are only accessed by the internal subnet.
InternalURLs:
"http://keep0.ClusterID.example.com:25107/": {}
"http://keep1.ClusterID.example.com:25107/": {}
# and so forth
$ echo "hello world!" > hello.txt $ arv-put --portable-data-hash hello.txt 2018-07-12 13:35:25 arvados.arv_put[28702] INFO: Creating new cache file at /home/example/.cache/arvados/arv-put/1571ec0adb397c6a18d5c74cc95b3a2a 0M / 0M 100.0% 2018-07-12 13:35:27 arvados.arv_put[28702] INFO: 2018-07-12 13:35:27 arvados.arv_put[28702] INFO: Collection saved as 'Saved at 2018-07-12 17:35:25 UTC by example@example' 59389a8f9ee9d399be35462a0f92541c+53 $ arv-get 59389a8f9ee9d399be35462a0f92541c+53/hello.txt hello world!h3. Note on storage management On its own, a keepstore server never deletes data. Instead, the keep-balance service determines which blocks are candidates for deletion and instructs the keepstore to move those blocks to the trash. Please see the "Balancing Keep servers":{{site.baseurl}}/admin/keep-balance.html for more details.