14745: Replaces debug println with proper return and doc clean up

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

diff --git a/services/keep-balance/usage.go b/services/keep-balance/usage.go
index b521c652cc6766f901c05513ade1197f527fca6d..b39e83905d617f58b605c22c7e1a43cc8aa4c8cb 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,18 @@ 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
+Listen: ":9005"
+ManagementToken: xyzzy
+RunPeriod: 600s
+CollectionBatchSize: 100000
+CollectionBuffers: 1000
+RequestTimeout: 30m`)

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


@@ -30,7 +33,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:
 `)


@@ -86,6 +89,11 @@ Tuning resource usage:
     while the current page is still being processed. If this is zero
     or omitted, pages are processed serially.
 
     while the current page is still being processed. If this is zero
     or omitted, pages are processed serially.
 

+    RequestTimeout is the maximum time keep-balance will spend on a
+    single HTTP request (getting a page of collections, getting the
+    block index from a keepstore server, or sending a trash or pull
+    list to a keepstore server). Defaults to 30 minutes.
+

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