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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keepstore servers
   5 ...
   6
   7 We are going to install two Keepstore servers. By convention, we use the following hostname pattern:
   8
   9 <div class="offset1">
  10 table(table table-bordered table-condensed).
  11 |_Hostname_|
  12 |keep0.@uuid_prefix@.your.domain|
  13 |keep1.@uuid_prefix@.your.domain|
  14 </div>
  15
  16 Because the Keepstore servers are not directly accessible from the internet, these hostnames only need to resolve on the local network.
  17
  18 h2. Install Keepstore
  19
  20 On Debian-based systems:
  21
  22 <notextile>
  23 <pre><code>~$ <span class="userinput">sudo apt-get install keepstore</span>
  24 </code></pre>
  25 </notextile>
  26
  27 On Red Hat-based systems:
  28
  29 <notextile>
  30 <pre><code>~$ <span class="userinput">sudo yum install keepstore</span>
  31 </code></pre>
  32 </notextile>
  33
  34 Verify that Keepstore is functional:
  35
  36 <notextile>
  37 <pre><code>~$ <span class="userinput">keepstore -h</span>
  38 2016/07/01 14:06:21 keepstore starting, pid 32339
  39 Usage of ./keepstore:
  40   -azure-max-get-bytes int
  41         Maximum bytes to request in a single GET request. If smaller than 67108864, use multiple concurrent range requests to retrieve a block. (default 67108864)
  42   -azure-storage-account-key-file string
  43         File containing the account key used for subsequent --azure-storage-container-volume arguments.
  44   -azure-storage-account-name string
  45         Azure storage account name used for subsequent --azure-storage-container-volume arguments.
  46   -azure-storage-container-volume value
  47         Use the given container as a storage volume. Can be given multiple times. (default [])
  48   -azure-storage-replication int
  49         Replication level to report to clients when data is stored in an Azure container. (default 3)
  50   -blob-signature-ttl int
  51         Lifetime of blob permission signatures in seconds. Modifying the ttl will invalidate all existing signatures. See services/api/config/application.default.yml. (default 1209600)
  52   -blob-signing-key-file string
  53         File containing the secret key for generating and verifying blob permission signatures.
  54   -data-manager-token-file string
  55         File with the API token used by the Data Manager. All DELETE requests or GET /index requests must carry this token.
  56   -enforce-permissions
  57         Enforce permission signatures on requests.
  58   -listen string
  59         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")
  60   -max-buffers int
  61         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)
  62   -max-requests int
  63         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)
  64   -never-delete
  65         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)
  66   -permission-key-file string
  67         Synonym for -blob-signing-key-file.
  68   -permission-ttl int
  69         Synonym for -blob-signature-ttl.
  70   -pid fuser -k pidfile
  71         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.
  72   -readonly
  73         Do not write, delete, or touch anything on the following volumes.
  74   -s3-access-key-file string
  75         File containing the access key used for subsequent -s3-bucket-volume arguments.
  76   -s3-bucket-volume value
  77         Use the given bucket as a storage volume. Can be given multiple times. (default [])
  78   -s3-endpoint string
  79         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".
  80   -s3-region string
  81         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"].
  82   -s3-replication int
  83         Replication level reported to clients for subsequent -s3-bucket-volume arguments. (default 2)
  84   -s3-secret-key-file string
  85         File containing the secret key used for subsequent -s3-bucket-volume arguments.
  86   -s3-unsafe-delete
  87         EXPERIMENTAL. Enable deletion (garbage collection), even though there are known race conditions that can cause data loss.
  88   -serialize
  89         Serialize read and write operations on the following volumes.
  90   -trash-check-interval duration
  91         Time duration at which the emptyTrash goroutine will check and delete expired trashed blocks. Default is one day. (default 24h0m0s)
  92   -trash-lifetime duration
  93         Time duration after a block is trashed during which it can be recovered using an /untrash request
  94   -volume value
  95         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 [])
  96   -volumes value
  97         Deprecated synonym for -volume. (default [])
  98 </code></pre>
  99 </notextile>
 100
 101 h3. Prepare storage volumes
 102
 103 {% include 'notebox_begin' %}
 104 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.
 105 {% include 'notebox_end' %}
 106
 107 There are two ways to specify a set of local directories where keepstore should store its data files.
 108 # Implicitly, by creating a directory called @keep@ at the top level of each filesystem you intend to use, and omitting @-volume@ arguments.
 109 # Explicitly, by providing a @-volume@ argument for each directory.
 110
 111 For example, if there are filesystems mounted at @/mnt@ and @/mnt2@:
 112
 113 <notextile>
 114 <pre><code>~$ <span class="userinput">mkdir /mnt/keep /mnt2/keep</span>
 115 ~$ <span class="userinput">keepstore</span>
 116 2015/05/08 13:44:26 keepstore starting, pid 2765
 117 2015/05/08 13:44:26 Using volume [UnixVolume /mnt/keep] (writable=true)
 118 2015/05/08 13:44:26 Using volume [UnixVolume /mnt2/keep] (writable=true)
 119 2015/05/08 13:44:26 listening at :25107
 120 </code></pre>
 121 </notextile>
 122
 123 Equivalently:
 124
 125 <notextile>
 126 <pre><code>~$ <span class="userinput">mkdir /mnt/keep /mnt2/keep</span>
 127 ~$ <span class="userinput">keepstore -volume=/mnt/keep -volume=/mnt2/keep</span>
 128 2015/05/08 13:44:26 keepstore starting, pid 2765
 129 2015/05/08 13:44:26 Using volume [UnixVolume /mnt/keep] (writable=true)
 130 2015/05/08 13:44:26 Using volume [UnixVolume /mnt2/keep] (writable=true)
 131 2015/05/08 13:44:26 listening at :25107
 132 </code></pre>
 133 </notextile>
 134
 135 h3. Run keepstore as a supervised service
 136
 137 Install runit to supervise the keepstore daemon.  {% include 'install_runit' %}
 138
 139 Install this script as the run script for the keepstore service, modifying it as directed below.
 140
 141 <notextile>
 142 <pre><code>#!/bin/sh
 143
 144 exec 2>&1
 145 exec GOGC=10 GOMAXPROCS=<span class="userinput">4</span> keepstore \
 146  -enforce-permissions=true \
 147  -blob-signing-key-file=<span class="userinput">/etc/keepstore/blob-signing.key</span> \
 148  -max-buffers=<span class="userinput">100</span> \
 149  -serialize=true \
 150  -volume=<span class="userinput">/mnt/keep</span> \
 151  -volume=<span class="userinput">/mnt2/keep</span>
 152 </code></pre>
 153 </notextile>
 154
 155 The @GOMAXPROCS@ environment variable determines the maximum number of concurrent threads, and should normally be set to the number of CPU cores present.
 156
 157 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.
 158
 159 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@.
 160
 161 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@.
 162
 163 h3. Set up additional servers
 164
 165 Repeat the above sections to prepare volumes and bring up supervised services on each Keepstore server you are setting up.
 166
 167 h3. Tell the API server about the Keepstore servers
 168
 169 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>.
 170
 171 Make sure to update the @service_host@ value to match each of your Keepstore servers.
 172
 173 <notextile>
 174 <pre><code>~$ <span class="userinput">prefix=`arv --format=uuid user current | cut -d- -f1`</span>
 175 ~$ <span class="userinput">echo "Site prefix is '$prefix'"</span>
 176 ~$ <span class="userinput">read -rd $'\000' keepservice &lt;&lt;EOF; arv keep_service create --keep-service "$keepservice"</span>
 177 <span class="userinput">{
 178  "service_host":"<strong>keep0.$prefix.your.domain</strong>",
 179  "service_port":25107,
 180  "service_ssl_flag":false,
 181  "service_type":"disk"
 182 }
 183 EOF</span>
 184 </code></pre></notextile>