Project

General

Profile

Actions

Feature #2894

closed

cli: help command for ceph subsystems

Added by Josh Durgin over 11 years ago. Updated over 9 years ago.

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.

Actions

Also available in: Atom PDF