Merge branch '7995-keep-balance-docs'
[arvados.git] / doc / install / install-keep-balance.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Install Keep-balance
5 ...
6
7 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).
8
9 {% include 'notebox_begin' %}
10
11 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@.
12
13 {% include 'notebox_end' %}
14
15 h2. Install keep-balance
16
17 Keep-balance can be installed anywhere with network access to Keep services. Typically it runs on the same host as keepproxy.
18
19 *A cluster should have only one keep-balance process running at a time.*
20
21 On Debian-based systems:
22
23 <notextile>
24 <pre><code>~$ <span class="userinput">sudo apt-get install keep-balance</span>
25 </code></pre>
26 </notextile>
27
28 On Red Hat-based systems:
29
30 <notextile>
31 <pre><code>~$ <span class="userinput">sudo yum install keep-balance</span>
32 </code></pre>
33 </notextile>
34
35 Verify that @keep-balance@ is functional:
36
37 <notextile>
38 <pre><code>~$ <span class="userinput">keep-balance -h</span>
39 ...
40 Usage: keep-balance [options]
41
42 Options:
43   -commit-pulls
44         send pull requests (make more replicas of blocks that are underreplicated or are not in optimal rendezvous probe order)
45   -commit-trash
46         send trash requests (delete unreferenced old blocks, and excess replicas of overreplicated blocks)
47 ...
48 </code></pre>
49 </notextile>
50
51 h3. Create a keep-balance token
52
53 Create an Arvados superuser token for use by keep-balance. *On the API server*, run:
54
55 <notextile>
56 <pre><code>apiserver:~$ <span class="userinput">cd /var/www/arvados-api/current</span>
57 apiserver:/var/www/arvados-api/current$ <span class="userinput">sudo -u <b>webserver-user</b> RAILS_ENV=production bundle exec script/create_superuser_token.rb</span>
58 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
59 </code></pre>
60 </notextile>
61
62 h3. Create a configuration file
63
64 On the host running keep-balance, create @/etc/arvados/keep-balance/keep-balance.yml@ using the token you generated in the previous step.  Follow this YAML format:
65
66 <notextile>
67 <pre><code>Client:
68   APIHost: <span class="userinput">uuid_prefix.your.domain</span>:443
69   AuthToken: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
70 KeepServiceTypes:
71   - disk
72 RunPeriod: 10m
73 CollectionBatchSize: 100000
74 CollectionBuffers: 1000
75 </code></pre>
76 </notextile>
77
78 If your API server's SSL certificate is not signed by a recognized CA, add the @Insecure@ option to the @Client@ section:
79
80 <notextile>
81 <pre><code>Client:
82   <span class="userinput">Insecure: true</span>
83   APIHost: ...
84 </code></pre>
85 </notextile>
86
87 h3. Start the service (option 1: systemd)
88
89 If your system does not use systemd, skip this section and follow the "runit instructions":#runit instead.
90
91 If your system uses systemd, the keep-balance service should already be set up. Start it and check its status:
92
93 <notextile>
94 <pre><code>~$ <span class="userinput">sudo systemctl restart keep-balance</span>
95 ~$ <span class="userinput">sudo systemctl status keep-balance</span>
96 &#x25cf; keep-balance.service - Arvados Keep Balance
97    Loaded: loaded (/lib/systemd/system/keep-balance.service; enabled)
98    Active: active (running) since Sat 2017-02-14 18:46:01 UTC; 3 days ago
99      Docs: https://doc.arvados.org/
100  Main PID: 541 (keep-balance)
101    CGroup: /system.slice/keep-balance.service
102            └─541 /usr/bin/keep-balance -commit-pulls -commit-trash
103
104 Feb 14 18:46:01 zzzzz.arvadosapi.com keep-balance[541]: 2017/02/14 18:46:01 starting up: will scan every 10m0s and on SIGUSR1
105 Feb 14 18:56:01 zzzzz.arvadosapi.com keep-balance[541]: 2017/02/14 18:56:01 Run: start
106 Feb 14 18:56:01 zzzzz.arvadosapi.com keep-balance[541]: 2017/02/14 18:56:01 skipping zzzzz-bi6l4-rbtrws2jxul6i4t with service type "proxy"
107 Feb 14 18:56:01 zzzzz.arvadosapi.com keep-balance[541]: 2017/02/14 18:56:01 clearing existing trash lists, in case the new rendezvous order differs from previous run
108 </code></pre>
109 </notextile>
110
111 h3(#runit). Start the service (option 2: runit)
112
113 Install runit to supervise the keep-balance daemon.  {% include 'install_runit' %}
114
115 Create a supervised service.
116
117 <notextile>
118 <pre><code>~$ <span class="userinput">sudo mkdir /etc/service/keep-balance</span>
119 ~$ <span class="userinput">cd /etc/service/keep-balance</span>
120 ~$ <span class="userinput">sudo mkdir log log/main</span>
121 ~$ <span class="userinput">printf '#!/bin/sh\nexec keep-balance -commit-pulls -commit-trash 2>&1\n' | sudo tee run</span>
122 ~$ <span class="userinput">printf '#!/bin/sh\nexec svlogd main\n' | sudo tee log/run</span>
123 ~$ <span class="userinput">sudo chmod +x run log/run</span>
124 ~$ <span class="userinput">sudo sv exit .</span>
125 ~$ <span class="userinput">cd -</span>
126 </code></pre>
127 </notextile>
128
129 Use @sv stat@ and check the log file to verify the service is running.
130
131 <notextile>
132 <pre><code>~$ <span class="userinput">sudo sv stat /etc/service/keep-balance</span>
133 run: /etc/service/keep-balance: (pid 12520) 2s; run: log: (pid 12519) 2s
134 ~$ <span class="userinput">tail /etc/service/keep-balance/log/main/current</span>
135 2017/02/14 18:46:01 starting up: will scan every 10m0s and on SIGUSR1
136 2017/02/14 18:56:01 Run: start
137 2017/02/14 18:56:01 skipping zzzzz-bi6l4-rbtrws2jxul6i4t with service type "proxy"
138 2017/02/14 18:56:01 clearing existing trash lists, in case the new rendezvous order differs from previous run
139 </code></pre>
140 </notextile>
141
142 h2. Enable delete operations on keepstore volumes
143
144 Ensure your keepstore services have the "delete" operation enabled. If it is disabled (which is the default), unneeded blocks will be identified by keep-balance, but will never be deleted from the underlying storage devices.
145
146 Add the @-never-delete=false@ command line flag to your keepstore run script:
147
148 <notextile>
149 <pre><code>keepstore <span class="userinput">-never-delete=false</span> -volume=...
150 </code></pre>
151 </notextile>
152
153 {% comment %}
154 // To replace the above section when the keepstore page recommends YAML...
155
156 Use the @EnableDelete@ flag in your YAML configuration file @/etc/arvados/keepstore/keepstore.yml@:
157
158 <notextile>
159 <pre><code>...
160 BlobSigningKeyFile: /etc/keepstore/blob-signing.key
161 <span class="userinput">EnableDelete: true</span>
162 Listen: :25107
163 ...
164 </code></pre>
165 </notextile>
166 {% endcomment %}