Actions
Feature #2894
closedcli: help command for ceph subsystems
Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
% Done:
0%
Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:
Description
To make commands and their usage discoverable and easy to look up, each subsystem could provide a help command
that listed each subcommand (and maybe its arguments?). Longer usage could then be obtained with an argument to help. This could look something like:
$ ceph help Usage: ceph SUBSYSTEM COMMAND [ARGS...] SUBSYSTEM may be one of: mds mon pg osd ... $ ceph help pg Available commands (use "ceph help pg COMMAND" for detailed information): dump [--format json|plain] [epoch] retrieve information about all placement groups set_full_ratio ratio update the threshold at which the cluster stops accepting I/O ... $ ceph help pg dump_stuck <full usage info here>
For things like 'ceph osd tell', an arbitrary osd could be queried, or 'ceph help osd tell N' could be accepted.
Updated by Anonymous over 11 years ago
It also has "ceph --help", which gives a list of many commands, but not all. Remove the list of commands from --help and make it recommend doing "ceph help" for that list?
Also, I don't see how this won't continue to suck & be out of date on the ceph-mon side also, unless we switch to a more declarative list of commands recognized, instead of a big pile of ifs.
Actions