doc/install/install-keepstore.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keepstore servers
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 We are going to install two Keepstore servers. By convention, we use the following hostname pattern:
  13
  14 <div class="offset1">
  15 table(table table-bordered table-condensed).
  16 |_Hostname_|
  17 |keep0.@uuid_prefix@.your.domain|
  18 |keep1.@uuid_prefix@.your.domain|
  19 </div>
  20
  21 Because the Keepstore servers are not directly accessible from the internet, these hostnames only need to resolve on the local network.
  22
  23 h2. Install Keepstore
  24
  25 On Debian-based systems:
  26
  27 <notextile>
  28 <pre><code>~$ <span class="userinput">sudo apt-get install keepstore</span>
  29 </code></pre>
  30 </notextile>
  31
  32 On Red Hat-based systems:
  33
  34 <notextile>
  35 <pre><code>~$ <span class="userinput">sudo yum install keepstore</span>
  36 </code></pre>
  37 </notextile>
  38
  39 Verify that Keepstore is functional:
  40
  41 <notextile>
  42 <pre><code>~$ <span class="userinput">keepstore -h</span>
  43 2016/07/01 14:06:21 keepstore starting, pid 32339
  44 Usage of ./keepstore:
  45   -azure-max-get-bytes int
  46         Maximum bytes to request in a single GET request. If smaller than 67108864, use multiple concurrent range requests to retrieve a block. (default 67108864)
  47   -azure-storage-account-key-file string
  48         File containing the account key used for subsequent --azure-storage-container-volume arguments.
  49   -azure-storage-account-name string
  50         Azure storage account name used for subsequent --azure-storage-container-volume arguments.
  51   -azure-storage-container-volume value
  52         Use the given container as a storage volume. Can be given multiple times. (default [])
  53   -azure-storage-replication int
  54         Replication level to report to clients when data is stored in an Azure container. (default 3)
  55   -blob-signature-ttl int
  56         Lifetime of blob permission signatures in seconds. Modifying the ttl will invalidate all existing signatures. See services/api/config/application.default.yml. (default 1209600)
  57   -blob-signing-key-file string
  58         File containing the secret key for generating and verifying blob permission signatures.
  59   -data-manager-token-file string
  60         File with the API token used by the Data Manager. All DELETE requests or GET /index requests must carry this token.
  61   -enforce-permissions
  62         Enforce permission signatures on requests.
  63   -listen string
  64         Listening address, in the form "host:port". e.g., 10.0.1.24:8000. Omit the host part to listen on all interfaces. (default ":25107")
  65   -max-buffers int
  66         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. (default 128)
  67   -max-requests int
  68         Maximum concurrent requests. When this limit is reached, new requests will receive 503 responses. Note: this limit does not include idle connections from clients using HTTP keepalive, so it does not strictly limit the number of concurrent connections. (default 2 * max-buffers)
  69   -never-delete
  70         If true, nothing will be deleted. Warning: the relevant features in keepstore and data manager have not been extensively tested. You should leave this option alone unless you can afford to lose data. (default true)
  71   -permission-key-file string
  72         Synonym for -blob-signing-key-file.
  73   -permission-ttl int
  74         Synonym for -blob-signature-ttl.
  75   -pid fuser -k pidfile
  76         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.
  77   -readonly
  78         Do not write, delete, or touch anything on the following volumes.
  79   -s3-access-key-file string
  80         File containing the access key used for subsequent -s3-bucket-volume arguments.
  81   -s3-bucket-volume value
  82         Use the given bucket as a storage volume. Can be given multiple times. (default [])
  83   -s3-endpoint string
  84         Endpoint URL used for subsequent -s3-bucket-volume arguments. If blank, use the AWS endpoint corresponding to the -s3-region argument. For Google Storage, use "https://storage.googleapis.com".
  85   -s3-region string
  86         AWS region used for subsequent -s3-bucket-volume arguments. Allowed values are ["ap-southeast-1" "eu-west-1" "us-gov-west-1" "sa-east-1" "cn-north-1" "ap-northeast-1" "ap-southeast-2" "eu-central-1" "us-east-1" "us-west-1" "us-west-2"].
  87   -s3-replication int
  88         Replication level reported to clients for subsequent -s3-bucket-volume arguments. (default 2)
  89   -s3-secret-key-file string
  90         File containing the secret key used for subsequent -s3-bucket-volume arguments.
  91   -s3-unsafe-delete
  92         EXPERIMENTAL. Enable deletion (garbage collection), even though there are known race conditions that can cause data loss.
  93   -serialize
  94         Serialize read and write operations on the following volumes.
  95   -trash-check-interval duration
  96         Time duration at which the emptyTrash goroutine will check and delete expired trashed blocks. Default is one day. (default 24h0m0s)
  97   -trash-lifetime duration
  98         Time duration after a block is trashed during which it can be recovered using an /untrash request
  99   -volume value
 100         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. (default [])
 101   -volumes value
 102         Deprecated synonym for -volume. (default [])
 103 </code></pre>
 104 </notextile>
 105
 106 h3. Prepare storage volumes
 107
 108 {% include 'notebox_begin' %}
 109 This section uses a local filesystem as a backing store. If you are using Azure Storage, follow the setup instructions on the "Azure Blob Storage":configure-azure-blob-storage.html page instead.
 110 {% include 'notebox_end' %}
 111
 112 There are two ways to specify a set of local directories where keepstore should store its data files.
 113 # Implicitly, by creating a directory called @keep@ at the top level of each filesystem you intend to use, and omitting @-volume@ arguments.
 114 # Explicitly, by providing a @-volume@ argument for each directory.
 115
 116 For example, if there are filesystems mounted at @/mnt@ and @/mnt2@:
 117
 118 <notextile>
 119 <pre><code>~$ <span class="userinput">mkdir /mnt/keep /mnt2/keep</span>
 120 ~$ <span class="userinput">keepstore</span>
 121 2015/05/08 13:44:26 keepstore starting, pid 2765
 122 2015/05/08 13:44:26 Using volume [UnixVolume /mnt/keep] (writable=true)
 123 2015/05/08 13:44:26 Using volume [UnixVolume /mnt2/keep] (writable=true)
 124 2015/05/08 13:44:26 listening at :25107
 125 </code></pre>
 126 </notextile>
 127
 128 Equivalently:
 129
 130 <notextile>
 131 <pre><code>~$ <span class="userinput">mkdir /mnt/keep /mnt2/keep</span>
 132 ~$ <span class="userinput">keepstore -volume=/mnt/keep -volume=/mnt2/keep</span>
 133 2015/05/08 13:44:26 keepstore starting, pid 2765
 134 2015/05/08 13:44:26 Using volume [UnixVolume /mnt/keep] (writable=true)
 135 2015/05/08 13:44:26 Using volume [UnixVolume /mnt2/keep] (writable=true)
 136 2015/05/08 13:44:26 listening at :25107
 137 </code></pre>
 138 </notextile>
 139
 140 h3. Run keepstore as a supervised service
 141
 142 Install runit to supervise the keepstore daemon.  {% include 'install_runit' %}
 143
 144 Install this script as the run script for the keepstore service, modifying it as directed below.
 145
 146 <notextile>
 147 <pre><code>#!/bin/sh
 148
 149 exec 2>&1
 150 exec GOGC=10 keepstore \
 151  -enforce-permissions=true \
 152  -blob-signing-key-file=<span class="userinput">/etc/keepstore/blob-signing.key</span> \
 153  -max-buffers=<span class="userinput">100</span> \
 154  -serialize=true \
 155  -never-delete=false \
 156  -volume=<span class="userinput">/mnt/keep</span> \
 157  -volume=<span class="userinput">/mnt2/keep</span>
 158 </code></pre>
 159 </notextile>
 160
 161 The @-max-buffers@ argument limits keepstore's memory usage. It should be set such that @max-buffers * 64MiB + 10%@ fits comfortably in memory. For example, @-max-buffers=100@ is suitable for a host with 8 GiB RAM.
 162
 163 If you want access control on your Keepstore server(s), you must specify the @-enforce-permissions@ flag and provide a signing key. The @-blob-signing-key-file@ argument should be a file containing a long random alphanumeric string with no internal line breaks (it is also possible to use a socket or FIFO: keepstore reads it only once, at startup). This key must be the same as the @blob_signing_key@ configured in the "API server's":install-api-server.html configuration file, @/etc/arvados/api/application.yml@.
 164
 165 The @-serialize=true@ (default: @false@) argument limits keepstore to one reader/writer process per storage partition. This avoids thrashing by allowing the storage device underneath the storage partition to do read/write operations sequentially. Enabling @-serialize@ can improve Keepstore performance if the storage partitions map 1:1 to physical disks that are dedicated to Keepstore, particularly so for mechanical disks. In some cloud environments, enabling @-serialize@ has also also proven to be beneficial for performance, but YMMV. If your storage partition(s) are backed by network or RAID storage that can handle many simultaneous reader/writer processes without thrashing, you probably do not want to set @-serialize@.
 166
 167 h3. Set up additional servers
 168
 169 Repeat the above sections to prepare volumes and bring up supervised services on each Keepstore server you are setting up.
 170
 171 h3. Tell the API server about the Keepstore servers
 172
 173 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 <strong>shell server</strong>.
 174
 175 Make sure to update the @service_host@ value to match each of your Keepstore servers.
 176
 177 <notextile>
 178 <pre><code>~$ <span class="userinput">prefix=`arv --format=uuid user current | cut -d- -f1`</span>
 179 ~$ <span class="userinput">echo "Site prefix is '$prefix'"</span>
 180 ~$ <span class="userinput">read -rd $'\000' keepservice &lt;&lt;EOF; arv keep_service create --keep-service "$keepservice"</span>
 181 <span class="userinput">{
 182  "service_host":"<strong>keep0.$prefix.your.domain</strong>",
 183  "service_port":25107,
 184  "service_ssl_flag":false,
 185  "service_type":"disk"
 186 }
 187 EOF</span>
 188 </code></pre></notextile>