Bug 1335952 - describe maintenance modes in man page
Summary: describe maintenance modes in man page
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: ovirt-hosted-engine-setup
Classification: oVirt
Component: Documentation
Version: 1.3.3.4
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ovirt-4.0.4
: 2.0.1.4
Assignee: Ido Rosenzwig
QA Contact: meital avital
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-05-13 15:24 UTC by Evgheni Dereveanchin
Modified: 2019-04-28 13:11 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Cause: No description, at the man page, of what each maintenance mode does Fix: Description of each mode added to the man page
Clone Of:
Environment:
Last Closed: 2016-09-26 12:36:33 UTC
oVirt Team: Integration
Embargoed:
rule-engine: ovirt-4.0.z+
rule-engine: planning_ack+
sbonazzo: devel_ack+
gklein: testing_ack+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
oVirt gerrit 60742 0 master MERGED Added information about maintenance modes in the man page. 2016-07-19 13:36:51 UTC
oVirt gerrit 62043 0 ovirt-hosted-engine-setup-2.0 MERGED Added information about maintenance modes in the man page. 2016-08-08 08:19:04 UTC

Description Evgheni Dereveanchin 2016-05-13 15:24:34 UTC
Description of problem:
 Currently the man page for "hosted-engine" provides the following information about maintenance:

 --set-maintenance --mode=<mode>
     Set maintenance status to the specified mode (global/local/none).

 Similar situation on the --help page:

 # hosted-engine --set-maintenance --help
 Usage: /sbin/hosted-engine set-maintenance --mode=<mode>
    Set maintenance status to the specified mode.  Valid values are:
    'global', 'local', and 'none'.
    Available only after deployment has completed.

 There is however no description of what each mode does and when it should be used.


Version-Release number of selected component (if applicable):
 ovirt-hosted-engine-setup-1.3.3.4-1.el7ev.noarch.rpm

Ways to improve:
 Describe each of the three modes in the man page so that users know which one to use.

Comment 2 meital avital 2016-08-16 06:35:58 UTC
Verified on version: 4.0.2.6-0.1.el7ev
ovirt-hosted-engine-setup-2.0.1.4-1.el7ev.noarch

man page:
   --set-maintenance --mode=<mode>
              Set maintenance status to the specified mode:
              global - Allow the administrator to start/stop/modify the engine
              VM without any worry of interference from the HA agents.
              local - Allow the administrator to  maintain  this  host.   Note
              that  if  you have only 2 nodes and one is in maintenance, there
              is only one host available to run the engine VM.
              none - Resume HA functionality.


--help page:
# hosted-engine --set-maintenance --help
Usage: /usr/sbin/hosted-engine --set-maintenance --mode=<mode>
    Set maintenance status to the specified mode.  Valid values are:
    'global', 'local', and 'none'.
    Available only after deployment has completed.


Note You need to log in before you can comment on or make changes to this bug.