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 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.
  13
  14 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.
  15
  16 By convention, we use the following hostname pattern:
  17
  18 <div class="offset1">
  19 table(table table-bordered table-condensed).
  20 |_Hostname_|
  21 |keep0.@uuid_prefix@.your.domain|
  22 |keep1.@uuid_prefix@.your.domain|
  23 </div>
  24
  25 Keepstore servers should not be directly accessible from the Internet (they are accessed via "keepproxy":install-keepproxy.html), so the hostnames only need to resolve on the private network.
  26
  27 h2. Install Keepstore
  28
  29 On Debian-based systems:
  30
  31 <notextile>
  32 <pre><code>~$ <span class="userinput">sudo apt-get install keepstore</span>
  33 </code></pre>
  34 </notextile>
  35
  36 On Red Hat-based systems:
  37
  38 <notextile>
  39 <pre><code>~$ <span class="userinput">sudo yum install keepstore</span>
  40 </code></pre>
  41 </notextile>
  42
  43 Verify that Keepstore is functional:
  44
  45 <notextile>
  46 <pre><code>~$ <span class="userinput">keepstore --version</span>
  47 </code></pre>
  48 </notextile>
  49
  50 h3. Create a superuser token
  51
  52 If you haven't already done so, create a superuser token.
  53
  54 {% include 'create_superuser_token' %}
  55
  56 h3. Update cluster config file
  57
  58 Add or update the following sections of @/etc/arvados/config.yml@ as needed. Refer to the examples and comments in the "default config.yml file":{{site.baseurl}}/admin/config.html for more information.
  59
  60 <notextile>
  61 <pre><code>Clusters:
  62   <span class="userinput">uuid_prefix</span>:
  63     SystemRootToken: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
  64     Services:
  65       Keepstore:
  66         InternalURLs:
  67           "http://<span class="userinput">keep0.uuid_prefix.example.com</span>:25107/": {}
  68     API:
  69       MaxKeepBlobBuffers: 128
  70 </code></pre>
  71 </notextile>
  72
  73 h3. Notes on storage management
  74
  75 On its own, a keepstore server never deletes data.  The "keep-balance":install-keep-balance.html service determines which blocks are candidates for deletion and instructs the keepstore to move those blocks to the trash.
  76
  77 When a block is newly written, it is protected from deletion for the duration in @BlobSignatureTTL@.  During this time, it cannot be trashed.
  78
  79 If keep-balance instructs keepstore to trash a block which is older than @BlobSignatureTTL@, and @EnableDelete@ is true, the block will be moved to "trash".  A block which is in the trash is no longer accessible by read requests, but has not yet been permanently deleted.  Blocks which are in the trash may be recovered using the "untrash" API endpoint.  Blocks are permanently deleted after they have been in the trash for the duration in @TrashLifetime@.
  80
  81 Keep-balance is also responsible for balancing the distribution of blocks across keepstore servers by asking servers to pull blocks from other servers (as determined by their "storage class":{{site.baseurl}}/admin/storage-classes.html and "rendezvous hashing order":{{site.baseurl}}/api/storage.html).  Pulling a block makes a copy.  If a block is overreplicated (i.e. there are excess copies) after pulling, it will be subsequently trashed on the original server.
  82
  83 h3. Configure storage volumes
  84
  85 Available storage volume types include POSIX filesystems and cloud object storage.
  86
  87 * To use a POSIX filesystem, including both local filesystems (ext4, xfs) and network file system such as GPFS or Lustre, follow the setup instructions on "Filesystem storage":configure-fs-storage.html
  88 * If you are using S3-compatible object storage (including Amazon S3, Google Cloud Storage, and Ceph RADOS), follow the setup instructions on "S3 Object Storage":configure-s3-object-storage.html
  89 * If you are using Azure Blob Storage, follow the setup instructions on "Azure Blob Storage":configure-azure-blob-storage.html
  90
  91 h2. Run keepstore as a supervised service
  92
  93 h3. Start the service (option 1: systemd)
  94
  95 If your system does not use systemd, skip this section and follow the "runit instructions":#runit instead.
  96
  97 If your system uses systemd, the keepstore service should already be set up. Restart it to read the updated configuration, and check its status:
  98
  99 <notextile>
 100 <pre><code>~$ <span class="userinput">sudo systemctl restart keepstore</span>
 101 ~$ <span class="userinput">sudo systemctl status keepstore</span>
 102 &#x25cf; keepstore.service - Arvados Keep Storage Daemon
 103    Loaded: loaded (/etc/systemd/system/keepstore.service; enabled; vendor preset: enabled)
 104    Active: active (running) since Tue 2019-09-10 14:16:29 UTC; 1s ago
 105      Docs: https://doc.arvados.org/
 106  Main PID: 25465 (keepstore)
 107     Tasks: 9 (limit: 4915)
 108    CGroup: /system.slice/keepstore.service
 109            └─25465 /usr/bin/keepstore
 110 [...]
 111 </code></pre>
 112 </notextile>
 113
 114 h3(#runit). Start the service (option 2: runit)
 115
 116 Install runit to supervise the keepstore daemon.  {% include 'install_runit' %}
 117
 118 Install this script as the run script @/etc/sv/keepstore/run@ for the keepstore service:
 119
 120 <notextile>
 121 <pre><code>#!/bin/sh
 122
 123 exec 2>&1
 124 GOGC=10 exec keepstore
 125 </code></pre>
 126 </notextile>
 127
 128 h2. Set up additional servers
 129
 130 Repeat the above sections to prepare volumes and bring up supervised services on each Keepstore server you are setting up.
 131
 132 h2. Restart the API server and controller
 133
 134 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.
 135
 136 <pre>
 137 sudo systemctl restart nginx arvados-controller
 138 </pre>
 139
 140 h2(#testing). Testing keep
 141
 142 Install the "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html
 143
 144 @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ must be set in the environment.
 145
 146 You should now be able to use @arv-put@ to upload collections and @arv-get@ to fetch collections:
 147
 148 <pre>
 149 $ echo "hello world!" > hello.txt
 150
 151 $ arv-put --portable-data-hash hello.txt
 152 2018-07-12 13:35:25 arvados.arv_put[28702] INFO: Creating new cache file at /home/example/.cache/arvados/arv-put/1571ec0adb397c6a18d5c74cc95b3a2a
 153 0M / 0M 100.0% 2018-07-12 13:35:27 arvados.arv_put[28702] INFO:
 154
 155 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'
 156 59389a8f9ee9d399be35462a0f92541c+53
 157
 158 $ arv-get 59389a8f9ee9d399be35462a0f92541c+53/hello.txt
 159 hello world!
 160 </pre>