Bug 1293971

Summary: [Docs][SHE] Document the hosted-engine command and common administrator tasks
Product: Red Hat Enterprise Virtualization Manager Reporter: Marina Kalinin <mkalinin>
Component: DocumentationAssignee: Julie <juwu>
Status: CLOSED CURRENTRELEASE QA Contact: Tahlia Richardson <trichard>
Severity: high Docs Contact:
Priority: high    
Version: 3.6.0CC: adahms, didi, gklein, juwu, lbopf, lsurette, mkalinin, msivak, rbalakri, srevivo, ykaul, ylavi
Target Milestone: ovirt-3.6.5   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-04-26 12:31:08 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Marina Kalinin 2015-12-23 19:23:51 UTC
Self-Hosted Engine(HE) Guide does not contain any information on how HE should be operated. It contains the installation, upgrade and migration sections, but missing the important section explaining how to operate this deployment.

The new section should contain an explanation about how Hosted Engine is organized, what is the VM used by hosted engine and what are its possible states, etc.
For example, reading the guides, you can figure out that you should use hosted-engine command to operate the environment, but it is nowhere clearly stated.
Next, reading hosted-engine quick help, it is very confusing about which VM it is talking about - the manager VM or any VM:
        --vm-start
            start VM on this host

Also, the relationship between ovirt-ha-broker and ovirt-ha-agent, and when each of the services is required to be running, should be explained.

Bottom line, HE guide is missing "How to" section.