X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d2c9ca9783955cef851d33639cae36044941abb3..9c983060b6f0fc6dc42310587b9858b7f8b968de:/doc/install/install-keep-balance.html.textile.liquid diff --git a/doc/install/install-keep-balance.html.textile.liquid b/doc/install/install-keep-balance.html.textile.liquid index a1bc3a2199..4c735a1eec 100644 --- a/doc/install/install-keep-balance.html.textile.liquid +++ b/doc/install/install-keep-balance.html.textile.liquid @@ -3,12 +3,17 @@ layout: default navsection: installguide title: Install Keep-balance ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -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). +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). {% include 'notebox_begin' %} -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, use the @keepstore -never-delete=true@ flag or remove the @-commit-trash@ flag from your keep-balance startup script. +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@. {% include 'notebox_end' %} @@ -16,6 +21,8 @@ h2. Install keep-balance Keep-balance can be installed anywhere with network access to Keep services. Typically it runs on the same host as keepproxy. +*A cluster should have only one keep-balance process running at a time.* + On Debian-based systems: @@ -57,9 +64,20 @@ zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz -h3. Create a configuration file +h3. Update keepstore configuration files + +On each node that runs keepstore, save the token you generated in the previous step in a text file like @/etc/arvados/keepstore/system-auth-token.txt@ and then create or update @/etc/arvados/keepstore/keepstore.yml@ with the following key: + + +
SystemAuthTokenFile: /etc/arvados/keepstore/system-auth-token.txt
+
+
+ +Restart all keepstore services to apply the updated configuration. + +h3. Create a keep-balance configuration file -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: +On the host running keep-balance, create @/etc/arvados/keep-balance/keep-balance.yml@ using the token you generated above. Follow this YAML format:
Client: