doc/install/install-keep-balance.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Keep-balance
   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 # "Introduction":#introduction
  13 # "Update config.yml":#update-config
  14 # "Install keep-balance package":#install-packages
  15 # "Start the service":#start-service
  16
  17 h2(#introduction). Introduction
  18
  19 Keep-balance deletes unreferenced and overreplicated blocks from Keep servers, makes additional copies of underreplicated blocks, and moves blocks into optimal locations as needed (e.g., after adding new servers). See "Balancing Keep servers":{{site.baseurl}}/admin/keep-balance.html for usage details.
  20
  21 Keep-balance can be installed anywhere with network access to Keep services, arvados-controller, and PostgreSQL. Typically it runs on the same host as keepproxy.
  22
  23 *A cluster should have only one instance of keep-balance running at a time.*
  24
  25 {% include 'notebox_begin' %}
  26
  27 If you are installing keep-balance on an existing system with valuable data, you can run keep-balance in "dry run" mode first and review its logs as a precaution. To do this, edit your keep-balance startup script to use the flags @-commit-pulls=false -commit-trash=false -commit-confirmed-fields=false@.
  28
  29 {% include 'notebox_end' %}
  30
  31 h2(#update-config). Update the cluster config
  32
  33 Edit the cluster config at @config.yml@ and set @Services.Keepbalance.InternalURLs@.  This port is only used to publish metrics.
  34
  35 <notextile>
  36 <pre><code>    Services:
  37       Keepbalance:
  38         InternalURLs:
  39           "http://<span class="userinput">keep.ClusterID.example.com</span>:9005/": {}
  40 </code></pre>
  41 </notextile>
  42
  43 Ensure your cluster configuration has @Collections.BlobTrash: true@ (this is the default).
  44
  45 <notextile>
  46 <pre><code># arvados-server config-dump | grep BlobTrash:
  47       BlobTrash: true
  48 </code></pre>
  49 </notextile>
  50
  51 If BlobTrash is false, unneeded blocks will be counted and logged by keep-balance, but they will not be deleted.
  52
  53 {% assign arvados_component = 'keep-balance' %}
  54
  55 {% include 'install_packages' %}
  56
  57 {% include 'start_service' %}