Description of problem: The command-line help for hosted-engine is incomplete. How reproducible: 100% Steps to Reproduce: 1. login to a hosted-engine node 2. enter "hosted-engine --help" or "hosted-engine <command> --help" For example: hosted-engine --help --set-shared-config Actual results: Usage: /usr/sbin/hosted-engine --set-shared-config key value [--type=<type>] Set shared storage configuration. Valid types are: he_local, he_shared, ha, broker. Available only after deployment has completed. New values for he_shared (hosted-engine.conf source on the shared storage) will be used by all hosts (re)deployed after the configuration change. Currently running hosts will still use the old values. New values for he_local will be set in the local instance of he configuration file on the local host. Expected results: 1. Add angle-brackets to variables in the syntax line (like "key" and "value") like this: Usage: /usr/sbin/hosted-engine --set-shared-config <key> <value> [--type=<type>] 2. Explain concepts: What are valid keys? What are valid values for the keys? What do the three different types mean/do? What are the different config files? Which commands edit which files? I see broker.conf, ha.conf, and hosted-engine.conf. Additional info:
IMO the '--help' should be minimal and useful, so maybe the explanation of the concepts we should add to the man page instead?
Perhaps it should have occurred to me to try man hosted-engine and that might have helped me. However, I still see a possible problem: Both the --help and the man page have the following line at the end: For additional information about a specific command try: <command> --help I do think it's necessary to add angle brackets around anything like "key" to indicate that this text is variable. Also, item 2 in comment 0 still applies: > 2. Explain concepts: What are valid keys? What are valid values for the keys? > What do the three different types mean/do? What are the different config files? > Which commands edit which files? I see broker.conf, ha.conf, and hosted-engine.conf.
alma03.qa.lab.tlv.redhat.com's password: Activate the web console with: systemctl enable --now cockpit.socket Last failed login: Tue Mar 10 13:37:21 IST 2020 from 10.36.118.216 on ssh:notty There was 1 failed login attempt since the last successful login. Last login: Tue Mar 10 08:55:47 2020 from 10.35.206.63 [root@alma03 ~]# hosted-engine --help --set-shared-config Usage: /usr/sbin/hosted-engine --set-shared-config <key> <value> [--type=<type>] Set shared storage configuration. Valid types are: he_local, he_shared, ha, broker. Available only after deployment has completed. New values for he_shared (hosted-engine.conf source on the shared storage) will be used by all hosts (re)deployed after the configuration change. Currently running hosts will still use the old values. New values for he_local will be set in the local instance of he configuration file on the local host. Moving to verified. Tested on these components: rhvm-appliance.x86_64 2:4.4-20200123.0.el8ev rhv-4.4.0 sanlock-3.8.0-2.el8.x86_64 qemu-kvm-4.2.0-12.module+el8.2.0+5858+afd073bc.x86_64 vdsm-4.40.5-1.el8ev.x86_64 libvirt-client-6.0.0-7.module+el8.2.0+5869+c23fe68b.x86_64 ovirt-hosted-engine-setup-2.4.2-2.el8ev.noarch ovirt-hosted-engine-ha-2.4.2-1.el8ev.noarch Linux 4.18.0-183.el8.x86_64 #1 SMP Sun Feb 23 20:50:47 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux Red Hat Enterprise Linux release 8.2 Beta (Ootpa) Engine is software version:4.4.0-0.17.master.el7 Red Hat Enterprise Linux Server release 7.8 Beta (Maipo) Linux 3.10.0-1123.el7.x86_64 #1 SMP Tue Jan 14 03:44:38 EST 2020 x86_64 x86_64 x86_64 GNU/Linux
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (RHV RHEL Host (ovirt-host) 4.4), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHEA-2020:3246