Bug 1553758

Summary: [Docs][SHE] Add explanation about RHVM Appliance
Product: Red Hat Enterprise Virtualization Manager Reporter: Marina Kalinin <mkalinin>
Component: DocumentationAssignee: Steve Goodman <sgoodman>
Status: CLOSED DUPLICATE QA Contact: rhev-docs <rhev-docs>
Severity: medium Docs Contact:
Priority: high    
Version: 4.1.9CC: dcadzow, lsurette, mgoldboi, mkalinin, mperina, sbonazzo, sgoodman, srevivo
Target Milestone: ovirt-4.3.3Keywords: Documentation, Triaged
Target Release: 4.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
: 1694666 (view as bug list) Environment:
Last Closed: 2019-04-01 11:28:30 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:
Bug Depends On:    
Bug Blocks: 1694666    

Description Marina Kalinin 2018-03-09 13:34:26 UTC
We should add clarification about RHVM appliance, that it is used for initial deployment only and following upgrades should be done from within the appliance itself, as it has been any other machine.
Specifically, check this kcs: https://access.redhat.com/solutions/2752071

Where to put that clarification?
Somewhere in HE guide.
Maybe under procedure 2.4, point 2 below, as a note:
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/self-hosted_engine_guide/deploying_self-hosted_engine

Or under separate chapter after the procedure is done.

Comment 1 Moran Goldboim 2018-03-11 14:40:40 UTC
(In reply to Marina from comment #0)
> We should add clarification about RHVM appliance, that it is used for
> initial deployment only and following upgrades should be done from within
> the appliance itself, as it has been any other machine.
> Specifically, check this kcs: https://access.redhat.com/solutions/2752071
> 
> Where to put that clarification?
> Somewhere in HE guide.
> Maybe under procedure 2.4, point 2 below, as a note:
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/
> html/self-hosted_engine_guide/deploying_self-hosted_engine
> 
> Or under separate chapter after the procedure is done.

if we are following this approach, we might want to technically prevent downloading the appliance every time there is an update to it, since it looks like a waste of time and space.

Comment 3 Martin Perina 2018-09-03 14:20:14 UTC
Moving to Integration, that's their field of domain

Comment 5 Sandro Bonazzola 2019-01-28 09:41:33 UTC
This bug has not been marked as blocker for oVirt 4.3.0.
Since we are releasing it tomorrow, January 29th, this bug has been re-targeted to 4.3.1.

Comment 8 Sandro Bonazzola 2019-02-13 10:29:17 UTC
To clarify:
- we don't ask the user to install the rhvm-appliance because the hosted-engine deployment takes care of doing it as part of the setup.
- once the deployment is complete there's no reason for keeping the appliance installed on the system, opened bug #1676825 for removing the rpm at the end of the deployment.

Comment 9 Sandro Bonazzola 2019-03-06 08:35:43 UTC
(In reply to Sandro Bonazzola from comment #8)
> To clarify:
> - we don't ask the user to install the rhvm-appliance because the
> hosted-engine deployment takes care of doing it as part of the setup.

user need to get the appliance installed on the system before trying to deploy hosted engine if connectivity won't be available during hosted engine deployment


> - once the deployment is complete there's no reason for keeping the
> appliance installed on the system, opened bug #1676825 for removing the rpm
> at the end of the deployment.

Comment 10 Steve Goodman 2019-04-01 06:14:58 UTC
(In reply to Moran Goldboim from comment #1)
> 
> if we are following this approach, we might want to technically prevent
> downloading the appliance every time there is an update to it, since it
> looks like a waste of time and space.

Sounds to me like what you're describing should be a separate BZ.

Comment 11 Steve Goodman 2019-04-01 06:37:41 UTC
(In reply to Marina from comment #0)
> We should add clarification about RHVM appliance, that it is used for
> initial deployment only and following upgrades should be done from within
> the appliance itself, as it has been any other machine.
> Specifically, check this kcs: https://access.redhat.com/solutions/2752071
> 
> Where to put that clarification?
> Somewhere in HE guide.
> Maybe under procedure 2.4, point 2 below, as a note:
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/
> html/self-hosted_engine_guide/deploying_self-hosted_engine
> 
> Or under separate chapter after the procedure is done.

I propose adding the following note: 

NOTE
The RHV-M Appliance is provided for the initial installation of the virtual machine that hosts the Manager. After installation, the appliance is not necessary. The appliance is not used when you upgrade the Manager.


I suggest putting this note into the following places:

* Intro to Chap 2 [1]
* Intro to Chap 8 (on upgrading) [2]

[1] https://access.redhat.com/documentation/en-aus/red_hat_virtualization/4.2/html-single/self-hosted_engine_guide/#Deploying_the_Self-Hosted_Engine_Using_the_CLI_deploy
[2] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/self-hosted_engine_guide/#Upgrading_the_Self-Hosted_Engine

Comment 12 Steve Goodman 2019-04-01 06:39:19 UTC
Sandro,

As a newcomer to RHV, I found the whole concept of the appliance to be very confusing. When I looked up what an appliance is, I found that it's a self-contained system used for a specific purpose. However, the way we use the term in the documentation, it is only for installing the virtual machine that hosts the engine. BUT we use the term inconsistently, which leads to more confusion. Specifically:
* We use the term in the documentation, as I just mentioned, to refer to something that installs the virtual machine that hosts the engine.
* But in the current SHE, in section 2.2, step 7 [1], the command prompt refers to the appliance as the actual virtual machine, not just something used to install the vm:
  > Please provide the FQDN you would like to use for the engine appliance.
  > Note: This will be the FQDN of the engine VM you are now going to launch,
  > it should not point to the base host or to any other existing machine.
  > Engine VM FQDN:  manager.example.com
  > Please provide the domain name you would like to use for the engine appliance.
  > Engine VM domain: [example.com]

[1] https://access.redhat.com/documentation/en-aus/red_hat_virtualization/4.2/html-single/self-hosted_engine_guide/#Deploying_the_Self-Hosted_Engine_Using_the_CLI_deploy

The command prompts and the documentation need to be in sync. The command prompts should be updated.

Comment 13 Steve Goodman 2019-04-01 11:28:30 UTC
I addressed this bug in conjunction as part of bug 1671111, so I'm closing this one as a duplicate. Please take a look at but 1671111, comment 15.

*** This bug has been marked as a duplicate of bug 1671111 ***

Comment 14 Sandro Bonazzola 2019-04-01 16:29:01 UTC
(In reply to Steve Goodman from comment #12)
> Sandro,
> 
> As a newcomer to RHV, I found the whole concept of the appliance to be very
> confusing. When I looked up what an appliance is, I found that it's a
> self-contained system used for a specific purpose. However, the way we use
> the term in the documentation, it is only for installing the virtual machine
> that hosts the engine. BUT we use the term inconsistently, which leads to
> more confusion. Specifically:
> * We use the term in the documentation, as I just mentioned, to refer to
> something that installs the virtual machine that hosts the engine.
> * But in the current SHE, in section 2.2, step 7 [1], the command prompt
> refers to the appliance as the actual virtual machine, not just something
> used to install the vm:
>   > Please provide the FQDN you would like to use for the engine appliance.
>   > Note: This will be the FQDN of the engine VM you are now going to launch,
>   > it should not point to the base host or to any other existing machine.
>   > Engine VM FQDN:  manager.example.com
>   > Please provide the domain name you would like to use for the engine
> appliance.
>   > Engine VM domain: [example.com]
> 
> [1]
> https://access.redhat.com/documentation/en-aus/red_hat_virtualization/4.2/
> html-single/self-hosted_engine_guide/#Deploying_the_Self-
> Hosted_Engine_Using_the_CLI_deploy
> 
> The command prompts and the documentation need to be in sync. The command
> prompts should be updated.

Can you please open a BZ against ovirt-hosted-engine-setup for this?