21126: Update keep-balance admin doc page.
authorTom Clegg <tom@curii.com>
Mon, 20 Nov 2023 19:37:02 +0000 (14:37 -0500)
committerTom Clegg <tom@curii.com>
Mon, 20 Nov 2023 19:37:02 +0000 (14:37 -0500)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

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

index 2785930de82fc30eb7f07ea359e10f0822181631..4d18307cf75a65cd9c78af775c7cd43cbf2b1d92 100644 (file)
@@ -30,14 +30,12 @@ The @Collections.BalancePeriod@ value in @/etc/arvados/config.yml@ determines th
 
 Keep-balance can also be run with the @-once@ flag to do a single scan/balance operation and then exit. The exit code will be zero if the operation was successful.
 
-h3. Committing
-
-Keep-balance computes and reports changes but does not implement them by sending pull and trash lists to the Keep services unless the @-commit-pull@ and @-commit-trash@ flags are used.
-
 h3. Additional configuration
 
 For configuring resource usage tuning and lost block reporting, please see the @Collections.BlobMissingReport@, @Collections.BalanceCollectionBatch@, @Collections.BalanceCollectionBuffers@ option in the "default config.yml file":{{site.baseurl}}/admin/config.html.
 
+The @Collections.BalancePullLimit@ and @Collections.BalanceTrashLimit@ configuration entries determine the maximum number of pull and trash operations keep-balance will attempt to apply on each keepstore server. If both values are zero, keep-balance will operate in "dry run" mode, where all changes are computed but none are committed.
+
 h3. Limitations
 
 Keep-balance does not attempt to discover whether committed pull and trash requests ever get carried out -- only that they are accepted by the Keep services. If some services are full, new copies of under-replicated blocks might never get made, only repeatedly requested.
index bb4ae7b3d8ef1b9b5f810d2cfecfe8901f7a2be0..05d27b7cb45ff121c43df6fec7544bdf0590c5cc 100644 (file)
@@ -24,7 +24,7 @@ Keep-balance can be installed anywhere with network access to Keep services, arv
 
 {% 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, edit your keep-balance startup script to use the flags @-commit-pulls=false -commit-trash=false -commit-confirmed-fields=false@.
+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, set the @Collections.BalancePullLimit@ and @Collections.BalanceTrashLimit@ configuration entries to zero.
 
 {% include 'notebox_end' %}