Merge branch '12737-wb-rails42-upgrade'

[arvados.git] / services / keep-balance / usage.go

diff --git a/services/keep-balance/usage.go b/services/keep-balance/usage.go
index 2273f3a57fef08ec716320bcce660470e24ecb3a..0f4effe6f4e9b7c4e2590cfeb48ef5cd729ec5cd 100644 (file)
--- a/services/keep-balance/usage.go
+++ b/services/keep-balance/usage.go
@@ -1,3 +1,7 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+

 package main
 
 import (
 package main
 
 import (


@@ -7,19 +11,15 @@ import (
 )
 
 var exampleConfigFile = []byte(`
 )
 
 var exampleConfigFile = []byte(`

-    {
-       "Client": {
-           "APIHost": "zzzzz.arvadosapi.com:443",
-           "AuthToken": "xyzzy",
-           "Insecure": false
-       },
-       "KeepServiceTypes": [
-           "disk"
-       ],
-       "RunPeriod": "600s",
-       "CollectionBatchSize": 100000,
-       "CollectionBuffers": 1000
-    }`)
+Client:
+    APIHost: zzzzz.arvadosapi.com:443
+    AuthToken: xyzzy
+    Insecure: false
+KeepServiceTypes:
+    - disk
+RunPeriod: 600s
+CollectionBatchSize: 100000
+CollectionBuffers: 1000`)

 
 func usage() {
        fmt.Fprintf(os.Stderr, `
 
 func usage() {
        fmt.Fprintf(os.Stderr, `


@@ -30,7 +30,7 @@ overreplicated and unreferenced blocks, and moves blocks to better
 positions (according to the rendezvous hash algorithm) so clients find
 them faster.
 
 positions (according to the rendezvous hash algorithm) so clients find
 them faster.
 

-Usage: keep-balance -config path/to/config.json [options]
+Usage: keep-balance [options]

 
 Options:
 `)
 
 Options:
 `)


@@ -73,6 +73,19 @@ Committing:
     Use the -commit-pull and -commit-trash flags to implement the
     computed changes.
 
     Use the -commit-pull and -commit-trash flags to implement the
     computed changes.
 

+Tuning resource usage:
+
+    CollectionBatchSize limits the number of collections retrieved per
+    API transaction. If this is zero or omitted, page size is
+    determined by the API server's own page size limits (see
+    max_items_per_response and max_index_database_read configs).
+
+    CollectionBuffers sets the size of an internal queue of
+    collections. Higher values use more memory, and improve throughput
+    by allowing keep-balance to fetch the next page of collections
+    while the current page is still being processed. If this is zero
+    or omitted, pages are processed serially.
+

 Limitations:
 
     keep-balance does not attempt to discover whether committed pull
 Limitations:
 
     keep-balance does not attempt to discover whether committed pull