X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c0082c57cb7c5e67115e7b03c8c85f74b5b29d0d..cf5d136d81bd22ce5340243643a4734f3cf20856:/doc/install/install-keepstore.html.textile.liquid?ds=sidebyside diff --git a/doc/install/install-keepstore.html.textile.liquid b/doc/install/install-keepstore.html.textile.liquid index 72b3c9817c..528d52f910 100644 --- a/doc/install/install-keepstore.html.textile.liquid +++ b/doc/install/install-keepstore.html.textile.liquid @@ -3,8 +3,17 @@ layout: default navsection: installguide title: Install Keepstore servers ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -We are going to install two Keepstore servers. By convention, we use the following hostname pattern: +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +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. + +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:
~$ keepstore -h
-2015/05/08 13:41:16 keepstore starting, pid 2565
-Usage of ./keepstore:
- -blob-signature-ttl=1209600: Lifetime of blob permission signatures. See services/api/config/application.default.yml.
- -blob-signing-key-file="": File containing the secret key for generating and verifying blob permission signatures.
- -data-manager-token-file="": File with the API token used by the Data Manager. All DELETE requests or GET /index requests must carry this token.
- -enforce-permissions=false: Enforce permission signatures on requests.
- -listen=":25107": Listening address, in the form "host:port". e.g., 10.0.1.24:8000. Omit the host part to listen on all interfaces.
- -max-buffers=128: Maximum RAM to use for data buffers, given in multiples of block size (64 MiB). When this limit is reached, HTTP requests requiring buffers (like GET and PUT) will wait for buffer space to be released.
- -never-delete=false: If set, nothing will be deleted. HTTP 405 will be returned for valid DELETE requests.
- -permission-key-file="": Synonym for -blob-signing-key-file.
- -permission-ttl=0: Synonym for -blob-signature-ttl.
- -pid="": Path to write pid file during startup. This file is kept open and locked with LOCK_EX until keepstore exits, so `fuser -k pidfile` is one way to shut down. Exit immediately if there is an error opening, locking, or writing the pid file.
- -readonly=false: Do not write, delete, or touch anything on the following volumes.
- -serialize=false: Serialize read and write operations on the following volumes.
- -volume=[]: Local storage directory. Can be given more than once to add multiple directories. If none are supplied, the default is to use all directories named "keep" that exist in the top level directory of a mount point at startup time. Can be a comma-separated list, but this is deprecated: use multiple -volume arguments instead.
- -volumes=[]: Deprecated synonym for -volume.
+~$ keepstore --version
~$ keepstore -blob-signing-key-file=./blob-signing-key
-2015/05/08 13:44:26 keepstore starting, pid 2765
-2015/05/08 13:44:26 Using volume [UnixVolume /mnt/keep] (writable=true)
-2015/05/08 13:44:26 listening at :25107
+Clusters:
+ uuid_prefix:
+ SystemRootToken: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+ Services:
+ Keepstore:
+ InternalURLs:
+ "http://keep0.uuid_prefix.example.com:25107/": {}
+ API:
+ MaxKeepBlobBuffers: 128
~$ 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
+[...]
+
+~$ prefix=`arv --format=uuid user current | cut -d- -f1`
-~$ echo "Site prefix is '$prefix'"
-~$ read -rd $'\000' keepservice <<EOF; arv keep_service create --keep-service "$keepservice"
-{
- "service_host":"keep0.$prefix.your.domain",
- "service_port":25107,
- "service_ssl_flag":false,
- "service_type":"disk"
-}
-EOF
-
#!/bin/sh
+
+exec 2>&1
+GOGC=10 exec keepstore
+
+
+
+h2. Set up additional servers
+
+Repeat the above sections to prepare volumes and bring up supervised services on each Keepstore server you are setting up.
+
+h2. Restart the API server and controller
+
+After adding all of your keepstore servers to the Services section, make sure the cluster config file is up to date on the API server host, and restart the API server and controller processes to ensure the changes are applied.
+
++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. + +You should now be able to use @arv-put@ to upload collections and @arv-get@ to fetch collections: + +
+$ 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! +