10 "github.com/ghodss/yaml"
15 knownTypes := []string{}
16 for _, vt := range VolumeTypes {
17 c.Volumes = append(c.Volumes, vt().Examples()...)
18 knownTypes = append(knownTypes, vt().Type())
20 exampleConfigFile, err := yaml.Marshal(c)
24 sort.Strings(knownTypes)
25 knownTypeList := strings.Join(knownTypes, ", ")
26 fmt.Fprintf(os.Stderr, `
28 keepstore provides a content-addressed data store backed by a local filesystem or networked storage.
30 Usage: keepstore -config path/to/keepstore.yml
31 keepstore [OPTIONS] -dump-config
33 NOTE: All options (other than -config) are deprecated in favor of YAML
34 configuration. Use -dump-config to translate existing
35 configurations to YAML format.
40 fmt.Fprintf(os.Stderr, `
47 Local port to listen on. Can be "address:port" or ":port", where
48 "address" is a host IP address or name and "port" is a port number
53 Format of request/response and error logs: "json" or "text".
57 Path to write PID file during startup. This file is kept open and
58 locked with LOCK_EX until keepstore exits, so "fuser -k pidfile" is
59 one way to shut down. Exit immediately if there is an error
60 opening, locking, or writing the PID file.
64 Maximum RAM to use for data buffers, given in multiples of block
65 size (64 MiB). When this limit is reached, HTTP requests requiring
66 buffers (like GET and PUT) will wait for buffer space to be
71 Maximum concurrent requests. When this limit is reached, new
72 requests will receive 503 responses. Note: this limit does not
73 include idle connections from clients using HTTP keepalive, so it
74 does not strictly limit the number of concurrent connections. If
75 omitted or zero, the default is 2 * MaxBuffers.
79 Local file containing the secret blob signing key (used to
80 generate and verify blob signatures). This key should be
81 identical to the API server's blob_signing_key configuration
86 Honor read requests only if a valid signature is provided. This
87 should be true, except for development use and when migrating from
92 Duration for which new permission signatures (returned in PUT
93 responses) will be valid. This should be equal to the API
94 server's blob_signature_ttl configuration entry.
98 Local file containing the Arvados API token used by keep-balance
99 or data manager. Delete, trash, and index requests are honored
104 Enable trash and delete features. If false, trash lists will be
105 accepted but blocks will not be trashed or deleted.
109 Time duration after a block is trashed during which it can be
110 recovered using an /untrash request.
114 How often to check for (and delete) trashed blocks whose
115 TrashLifetime has expired.
119 List of storage volumes. If omitted or empty, the default is to
120 use all directories named "keep" that exist in the top level
121 directory of a mount point at startup time.
125 (See volume configuration examples above.)
127 `, exampleConfigFile, knownTypeList)