X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b144996ab73b15233f027713faf3114f34985e72..feb290061b91fa059aefd251ed3c3532b32620ea:/doc/install/install-keepstore.html.textile.liquid diff --git a/doc/install/install-keepstore.html.textile.liquid b/doc/install/install-keepstore.html.textile.liquid index 92fd91eb02..fedeb3c3f6 100644 --- a/doc/install/install-keepstore.html.textile.liquid +++ b/doc/install/install-keepstore.html.textile.liquid @@ -9,152 +9,101 @@ 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 +# "Note on storage management":#note + +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:
~$ sudo apt-get install keepstore
-
-~$ sudo yum install keepstore
-
-~$ keepstore --version
-
-Clusters:
- uuid_prefix:
- SystemRootToken: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
- Services:
+ Services:
Keepstore:
+ # No ExternalURL because they are only accessed by the internal subnet.
InternalURLs:
- "http://keep0.uuid_prefix.your.domain:25107/": {}
- API:
- MaxKeepBlockBuffers: 128
+ "http://keep0.ClusterID.example.com:25107/": {}
+ "http://keep1.ClusterID.example.com:25107/": {}
+ # and so forth
~$ sudo systemctl restart keepstore
-~$ sudo systemctl status keepstore
-● keepstore.service - Arvados Keep Storage Daemon
- Loaded: loaded (/etc/systemd/system/keepstore.service; enabled; vendor preset: enabled)
- Active: active (running) since Tue 2019-09-10 14:16:29 UTC; 1s ago
- Docs: https://doc.arvados.org/
- Main PID: 25465 (keepstore)
- Tasks: 9 (limit: 4915)
- CGroup: /system.slice/keepstore.service
- ââ25465 /usr/bin/keepstore
+
+$ arv keep_service accessible
[...]
#!/bin/sh
-
-exec 2>&1
-GOGC=10 exec keepstore
-
--sudo systemctl restart nginx arvados-controller -- -h2(#testing). Testing keep - -Install the "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html - -@ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ must be set in the environment. +If keepstore does not show up in the "accessible" list, and you are accessing it from within the private network, check that you have "properly configured the @geo@ block for the API server":install-api-server.html#update-nginx . -You should now be able to use @arv-put@ to upload collections and @arv-get@ to fetch collections: +Next, install the "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html -
-$ echo "hello world!" > hello.txt +You should now be able to use @arv-put@ to upload collections and @arv-get@ to fetch collections. Be sure to execute this from _inside_ the cluster's private network. You will be able to access keep from _outside_ the private network after setting up "keepproxy":install-keepproxy.html . -$ 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: +{% include 'arv_put_example' %} -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 +h2(#note). Note on storage management -$ arv-get 59389a8f9ee9d399be35462a0f92541c+53/hello.txt -hello world! -+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.