Bug 1335952
| Summary: | describe maintenance modes in man page | ||
|---|---|---|---|
| Product: | [oVirt] ovirt-hosted-engine-setup | Reporter: | Evgheni Dereveanchin <ederevea> |
| Component: | Documentation | Assignee: | Ido Rosenzwig <irosenzw> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | meital avital <mavital> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 1.3.3.4 | CC: | bugs, sbonazzo, stirabos, ylavi |
| Target Milestone: | ovirt-4.0.4 | Flags: | rule-engine:
ovirt-4.0.z+
rule-engine: planning_ack+ sbonazzo: devel_ack+ gklein: testing_ack+ |
| Target Release: | 2.0.1.4 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| 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
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-09-26 12:36:33 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Integration | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
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.
|
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.