X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/61c91fe02574ad751c2c957f6ca0d2e1e21105f9..6da6b846097364da3abed2abad272e9607b15ca8:/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 efeff65b83..d6a529d38b 100644 --- a/doc/install/install-keepstore.html.textile.liquid +++ b/doc/install/install-keepstore.html.textile.liquid @@ -3,138 +3,99 @@ 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 %} -
~$ sudo apt-get install keepstore
-
-~$ sudo yum install keepstore
-
-~$ keepstore -h
-2015/05/08 13:41:16 keepstore starting, pid 2565
-Usage of ./keepstore:
- -azure-storage-account-key-file="": File containing the account key used for subsequent --azure-storage-container-volume arguments.
- -azure-storage-account-name="": Azure storage account name used for subsequent --azure-storage-container-volume arguments.
- -azure-storage-container-volume=[]: Use the given container as a storage volume. Can be given multiple times.
- -azure-storage-replication=3: Replication level to report to clients when data is stored in an Azure container.
- -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.
-
-~$ mkdir /mnt/keep /mnt2/keep
-~$ keepstore
-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 Using volume [UnixVolume /mnt2/keep] (writable=true)
-2015/05/08 13:44:26 listening at :25107
-
-~$ mkdir /mnt/keep /mnt2/keep
-~$ keepstore -volume=/mnt/keep -volume=/mnt2/keep
-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 Using volume [UnixVolume /mnt2/keep] (writable=true)
-2015/05/08 13:44:26 listening at :25107
+ 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
#!/bin/sh
-
-exec 2>&1
-exec GOGC=10 GOMAXPROCS=4 keepstore \
- -enforce-permissions=true \
- -blob-signing-key-file=/etc/keepstore/blob-signing.key \
- -max-buffers=100 \
- -serialize=true \
- -volume=/mnt/keep \
- -volume=/mnt2/keep
-
-+$ echo "hello world!" > hello.txt -The API server needs to be informed about the presence of your Keepstore servers. For each of the Keepstore servers you have created, please execute the following commands on your shell server. +$ 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: -Make sure to update the @service_host@ value to match each of your Keepstore servers. +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 -+ +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.- +$ arv-get 59389a8f9ee9d399be35462a0f92541c+53/hello.txt +hello world! +~$ 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 -