Bug 1395294 - [Docs][Upgrade] Add reference to SHE maintenance and upgrade section in the general update guide
Summary: [Docs][Upgrade] Add reference to SHE maintenance and upgrade section in the g...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.0.0
Hardware: Unspecified
OS: Unspecified
high
unspecified
Target Milestone: ovirt-4.1.3
: ---
Assignee: Emma Heftman
QA Contact: Byron Gravenorst
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-11-15 16:07 UTC by Gianluca Cecchi
Modified: 2019-05-07 12:56 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-07-31 08:19:07 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Gianluca Cecchi 2016-11-15 16:07:43 UTC
Description of problem:
In my opinion it is not clear in RHEV documentation that if you have a Self Hosted Engine environment you have to put global maintenance before upgrading engine.
Inside the Upgrade Guide it is only covered the specific case when you migrate from 3.6 to 4.0 the Self Hosted Engine, while in minor upgrades at
https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/paged/upgrade-guide/chapter-2-updates-between-minor-releases
it is not specified.

Inside the Self Hosted Engine guide at 
https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/paged/self-hosted-engine-guide/chapter-5-maintenance-and-upgrading-resources  

when describing maintenance modes it is indeed specified 
"
The global maintenance mode must be applied for any setup or upgrade operations that require the engine to be stopped, such as upgrading to a later version of Red Hat Virtualization.
"
but in my opinion it should be put in clear also inside the Upgrade Guide.
In case let me know how can I open a documentation bug for this if you agree.

Version-Release number of selected component (if applicable):
4.0

How reproducible:
Always

Steps to Reproduce:
1. Read Upgrade Guide and Self Hosted Engine Guide
2.
3.

Actual results:


Expected results:


Additional info:

Comment 1 Lucy Bopf 2017-06-20 05:12:35 UTC
Assigning to Emma for review.

Comment 2 Emma Heftman 2017-06-27 13:51:38 UTC
Hey Sandro. 
Can you please confirm whether it is necessary to put the manager into global maint. mode before running setup-engine when upgrading the Manager to a minor version, as documented in step 4 here:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/upgrade_guide/#Upgrading_between_Minor_Releases

If yes, pls. confirm whether this is true for 4.0 and 4.1.

I assume this is not required for major upgrades which involves reinstalling the OS.

Comment 3 Sandro Bonazzola 2017-06-27 13:57:38 UTC
(In reply to Emma Heftman from comment #2)
> Hey Sandro. 
> Can you please confirm whether it is necessary to put the manager into
> global maint. mode before running setup-engine when upgrading the Manager to
> a minor version, as documented in step 4 here:
> 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/
> html-single/upgrade_guide/#Upgrading_between_Minor_Releases
> 
> If yes, pls. confirm whether this is true for 4.0 and 4.1.
> 
> I assume this is not required for major upgrades which involves reinstalling
> the OS.

Putting the system in global maintenance is required when running engine-setup.
Reason is that while upgrading the engine it won't be reachable and the hosted engine agent will loose connection to it, considering it dead.
This will fence the hosted engine VM with potential data corruption being the VM performing a database schema update.

The only upgrade requiring a full reinstall of the OS where the engine lives is from 3.6/el6 to 4.0/el7.

Comment 4 Emma Heftman 2017-06-27 14:27:38 UTC
Hi Giancula. After discussing this issue with Sandro, it is not clear to me exactly what you think is missing from the Upgrade Guide. Please see the following points and let me know whether you still think whether there is something missing.

Just to clarify some issues.
1. Global maintenance is required whenever we run engine-setup on a Self-Hosted Engine. 

2. It is not relevant for "regular" Manager upgrades. This is the reason it is not discussed in the Upgrade Guide which only discusses the Manager, and not the Self-Hosted Engine upgrades.

3. In the 4.0 Self-Hosted Engine Guide, we do document putting the Manager into global maintenance mode, before performing major and minor upgrades:

5.3 Upgrading a RHEL-Based Self-Hosted Engine Environment: 
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/self-hosted_engine_guide/#Upgrading_the_Self-Hosted_Engine

5.4 Upgrading a RHEV-H-Based Self-Hosted Engine Environment
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/self-hosted_engine_guide/#Upgrading_a_RHEV-H-Based_Self-Hosted_Engine_Environment

5.6 Updating the Self-Hosted Engine Manager Between Minor Releases
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/self-hosted_engine_guide/#Updating_a_Self-Hosted_Engine_to_a_Minor_Release

Comment 5 Gianluca Cecchi 2017-06-29 09:43:01 UTC
Hello, I focus in already released 4.1.

At the main page for it you have section named

Installation

ANd inside it you have

Self-Hosted Engine Guide
Installation Guide
Upgrade Guide

Inside Upgrade Guide of 4.1 in Chapter 3 (Upgrading to Red Hat Virtualization 4.1) you have section
3.4 Upgrading the Self-Hosted Engine
and in it you write to point at:
https://access.redhat.com/documentation/en/red-hat-virtualization/4.1/single/self-hosted-engine-guide/#Upgrading_the_Self-Hosted_Engine

So to be consistent, in chapter 2 of the same Upgrade Guide (Updates between minor releases), where you have 
2.1 Updating the Red Hat Virtualization Manager
I would add a 
2.1.2 Updating the Self-Hosted Engine
with a pointer to
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/self-hosted_engine_guide/updating_a_self-hosted_engine_to_a_minor_release

Or a 2.4 Updating the Self-Hosted Engine
with the same pointer as above

Or simply add a note in section 2.1, where you remind the user

To update a self-hosted engine between minor releases, see Updating the Self-Hosted Engine Manager between minor releases (link to https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/self-hosted_engine_guide/updating_a_self-hosted_engine_to_a_minor_release) in the Self-Hosted Engine Guide.

Hope I have detailed my point.

Comment 6 Gianluca Cecchi 2017-06-29 09:44:19 UTC
Obviously 
2.1.2 Updating the Self-Hosted Engine
in comment#5 

has to be 
2.1.1 Updating the Self-Hosted Engine

Comment 7 Emma Heftman 2017-06-29 12:45:58 UTC
(In reply to Gianluca Cecchi from comment #6)
> Obviously 
> 2.1.2 Updating the Self-Hosted Engine
> in comment#5 
> 
> has to be 
> 2.1.1 Updating the Self-Hosted Engine

Thanks Gianluca.

The bug's description referred to an issue with "global maintenance" which I thought you were trying to imply is missing from the Upgrade Guide.

Anyway, I now understand that you simply wanted a reference to the Self-Hosted Engine Guide, which includes the fact that you must first put the Manager into global maintenance mode.

Please refer the new section that I added to the Upgrade Guide - 2.4, and confirm that this is what was missing.

http://file.tlv.redhat.com/~eheftman/bz1395294/html-single/#Updating_Self_Hosted_Engine

Comment 8 Gianluca Cecchi 2017-06-29 13:17:18 UTC
Unfortunately I have not access to this "redhat" hostname....
But you have picked up the point I was stressing.
Thank,
Gianluca

Comment 10 Byron Gravenorst 2017-07-28 05:41:30 UTC
Reviewed and verified.

Comment 11 Emma Heftman 2017-07-31 08:19:07 UTC
The Customer Portal now contains the updated documentation:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html-single/upgrade_guide/#Updating_Self_Hosted_Engine


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