Ceph » bluestore

Ref: https://bugzilla.redhat.com/show_bug.cgi?id=2237367

Description of problem:
When using the ceph-bluestore-tool fsck command, the help message for the --deep option and the --path option placement appears to be inconsistent and confusing. This inconsistency can lead to user confusion and incorrect command usage.

The expected behavior for a well-documented command is to provide clear and concise help messages that accurately describe the purpose and usage of each option. In this case, the help message for the --deep option and the --path option needs correction to ensure clarity and accuracy.

When the param is added at the end of the command, the error message displayed is not informative enough for the user to provide the correct command.

[1] # ceph-bluestore-tool fsck --path /var/lib/ceph/osd/ceph-1/ --deep
the required argument for option '--deep' is missing

But when the placement of the "--deep" arg is changed, the error message becomes more descriptive.

[2] # ceph-bluestore-tool fsck --deep --path /var/lib/ceph/osd/ceph-1/
the argument ('--path') for option '--deep' is invalid. Valid choices are 'on|off', 'yes|no', '1|0' and 'true|false'

The error handling should be improved irrespective of the argument placement in the command. Observe the inconsistency in the error message based on the argument placement.

Even the documentation does not give the clear description as to what args that need to be supplied to the command. This needs to be improved as well.

fsck [ --deep ]

run consistency check on BlueStore metadata. If --deep is specified, also read all object data and verify checksums.

ref: https://docs.ceph.com/en/latest/man/8/ceph-bluestore-tool/#commands

Version-Release number of selected component (if applicable):
ceph version 18.2.0-2.el9cp (cbed2329dbd9e1c06cf77afcfad901ae16cc5e6a) reef (stable)

How reproducible:
Always

Steps to Reproduce:
1. Stop the OSD, and mount the OSD via cephadm shell to execute CBT commands. mount is optional
CMD : cephadm shell --name osd.1 --mount /root/ops/:/tmp
2. Execute commands [1] & [2] and observe the discrepancy in the error messages.

Actual results:
Inconsistent error messages displayed based on the position of optional argument in the command

Expected results:
The help message for the ceph-bluestore-tool fsck command should clearly indicate the proper usage of the --deep and --path options, ensuring that users can understand the correct placement of these options, irrespective of where in the command they are used.