Documentation #5690
closed
ceph "global options" should be documented somewhere
Added by Dan Mick almost 11 years ago.
Updated over 4 years ago.
Description
There are a number of global options that virtually every Ceph tool supports; things like
-i/--id, -n/--name, -c/--conf, --keyring, --keyfile, etc. etc. Many of them are unknown to all
but the literati.
We should have a page that documents these that is referred to by the individual command pages,
since their use is common across many tools/daemons.
Here's some notes I scribbled for myself:
early_options:
--version: show version to stdout, exit
--conf/-c: set config file path
--cluster: set cluster name
-i (daemon only)/--id/--user: set 'id' part of type.id name
-n/--name: set 'type.id' name
"parse_argv" options:
--show-conf: dump cf with cerr << and exit
--show-config: expand_all_meta(), then _show_config to cout, exit
--show-config_value: --show-config for a particular value
--foreground/-f: set:
daemonize false
pid_file ""
-d: set:
daemonize false
log_file ""
pid_file ""
log_to_stderr true
err_to_stderr true
log_to_syslog false
--monmap/-M: set monmap from file
--mon-host/-m: set mon_host (mon to contact, otherwise random)
--bind: set public_addr
--keyfile/-K: keyfile
--keyring/-k: keyring file
--<config-option>=<val> or
--<config-option> <val>
dashes or underscores in config-option are legal
--no-<config-option> sets bools to false
- Assignee set to John Wilkins
- Status changed from New to Closed
This bug has been judged too old to fix. This is because either it is either
1) raised against a version of Ceph prior to Luminous, or
2) just really old, and untouched for so long that it is unlikely nowadays to represent a live documentation concern.
If you think that the closing of this bug is an error, raise another bug of a similar kind. If you think that the matter requires urgent attention, please let Zac Dover know at zac.dover@gmail.com.
Also available in: Atom
PDF