Bug 1348528
| Summary: | different content of man page and help message | ||
|---|---|---|---|
| Product: | [Red Hat Storage] Red Hat Ceph Storage | Reporter: | Martin Kudlej <mkudlej> |
| Component: | Ceph-Installer | Assignee: | Christina Meno <gmeno> |
| Status: | CLOSED WONTFIX | QA Contact: | ceph-qe-bugs <ceph-qe-bugs> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 3.0 | CC: | adeza, anharris, aschoen, ceph-eng-bugs, kdreyer, mhackett, nthomas, sankarshan |
| Target Milestone: | rc | ||
| Target Release: | 3.1 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2018-02-20 12:20:22 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
I wonder if we should rename this utility "ceph-installer-troubleshooter". The name is awfully generic and we don't expect users to run this unless there are problems. |
Description of problem: man page content: CEPH-INSTALLER(8) CEPH-INSTALLER(8) NAME ceph-installer - Command line utility to install and configure Ceph using an HTTP REST API GLOBAL OPTIONS -h, --help, help Show this program's help menu --log, --logging Set the level of logging. Acceptable values: debug, warning, error, critical ENVIRONMENT VARIABLES CEPH_INSTALLER_ADDRESS Define the location of the installer. Defaults to "http://localhost:8181" COMMANDS task Human-readable task information: stdout, stderr, and the ability to "poll" a task that waits until the command completes to be able to show the output in a readable way. Usage: ceph-installer task $IDENTIFIER Options: --poll Poll until the task has completed (either on failure or success) stdout Retrieve the stdout output from the task stderr Retrieve the stderr output from the task command The actual command used to call ansible ended The timestamp (in UTC) when the command completed started The timestamp (in UTC) when the command started exit_code The shell exit status for the process succeeded Boolean value to indicate if process completed correctly dev Deploying the ceph-installer HTTP service to a remote server with ansible. This command wraps ansible and certain flags to make it easier to deploy a development version. Usage: ceph-installer dev $HOST Note: Requires a remote user with passwordless sudo. User defaults to "vagrant". Options: --user Define a user to connect to the remote server. Defaults to 'vagrant' --branch What branch to use for the deployment. Defaults to 'master' -vvvv Enable high verbosity when running ansible help message content: A command line utility to install and configure Ceph using an HTTP API as a REST service to call Ansible. Address: http://localhost:8181/ Version: 1.0.11 Global Options: -h, --help, help Show this program's help menu --log, --logging Set the level of logging. Acceptable values: debug, warning, error, critical Environment Variables: CEPH_INSTALLER_ADDRESS Define the location of the installer. Defaults to "http://localhost:8181" Available subcommands: task /api/tasks/ operations dev Development options Version-Release number of selected component (if applicable): ceph-installer-1.0.11-1.el7scon.noarch How reproducible: 100% Expected results: I think there should be note in help message that more info can be found in man page OR there should be at least task command options in help mesage OR man page and help message should be the same.