Bug 1391717

Summary: [Docs][SHE] Clarify information/procedures for SHE VM minor upgrades
Product: Red Hat Enterprise Virtualization Manager Reporter: Marina Kalinin <mkalinin>
Component: DocumentationAssignee: Emma Heftman <eheftman>
Status: CLOSED CURRENTRELEASE QA Contact: Byron Gravenorst <bgraveno>
Severity: high Docs Contact:
Priority: medium    
Version: 4.0.3CC: jcoscia, lbopf, lsurette, mkalinin, rbalakri, srevivo, ykaul, ylavi
Target Milestone: ovirt-4.1.2   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: hosted-engine
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-06-19 08:35:23 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:

Description Marina Kalinin 2016-11-03 20:22:26 UTC
Going through the guides, I could not find documentation for upgrading HE VM between minor 4.0 upgrades.
It only tells how to upgrade it from 3.6 to 4.0.

https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/single/self-hosted-engine-guide/#Upgrading_a_RHEV-H-Based_Self-Hosted_Engine_Environment

https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/single/self-hosted-engine-guide/#Upgrading_the_Self-Hosted_Engine


What should be the process, btw?
Should we upgrade it using upgrade-appliance flow or from within the appliance itself, subscribing it to the required channels and using engine-setup?

Comment 1 Marina Kalinin 2016-11-06 21:36:55 UTC
After initial deployment upgrade are done in the same way like regular environment.

i.e. we should subscribe it to the relevant channels, run `yum update` inside and run `engine-setup` if updates are available.

Comment 2 Marina Kalinin 2016-11-18 22:29:37 UTC
I do not want to open a separate bug for this, but there is also no process for hosts upgrades, for z-stream upgrades.

Comment 3 Marina Kalinin 2017-01-12 15:51:25 UTC
So, basically, I believe we need two additions here to SHE guide:
1. After initial deployment, we need a section explaining that HE VM needs to be registered to the right channels, after it is up and running, just as any other Manager.
2. In the upgrades section we need to clarify how HE VM should be upgraded. Which is exact same as a regular manager. And it can be done, after #1 above is done.

Comment 4 Javier Coscia 2017-03-27 21:47:03 UTC
I think we also need to add that the HE RHV-M upgrade needs you to place the global maintenance to avoid HA agent restart the HE VM in another host in the HE cluster since engine-setup will restart the service at some point.

Comment 5 Lucy Bopf 2017-05-12 06:27:40 UTC
Assigning to Emma for review.

Emma, see comment 3 and comment 4 for the suggested updates. It may be possible to cover this with a few explanatory sentences and links to existing sections in the Install or Upgrade guides.

Comment 6 Emma Heftman 2017-05-21 12:04:48 UTC
(In reply to Javier Coscia from comment #4)
> I think we also need to add that the HE RHV-M upgrade needs you to place the
> global maintenance to avoid HA agent restart the HE VM in another host in
> the HE cluster since engine-setup will restart the service at some point.

Hi Javier
Can you please explain what you mean by "HE RHV-M upgrade needs you to place the
> global maintenance"

And please provide the precise instructions for doing this.

Thanks
Emma

Comment 7 Emma Heftman 2017-05-21 12:38:28 UTC
(In reply to Emma Heftman from comment #6)
> (In reply to Javier Coscia from comment #4)
> > I think we also need to add that the HE RHV-M upgrade needs you to place the
> > global maintenance to avoid HA agent restart the HE VM in another host in
> > the HE cluster since engine-setup will restart the service at some point.
> 
> Hi Javier
> Can you please explain what you mean by "HE RHV-M upgrade needs you to place
> the
> > global maintenance"
> 
> And please provide the precise instructions for doing this.
> 
> Thanks
> Emma

Javier, I understand what global maintenance is but can you please clarify exactly at which stage it should be implemented?

After deployment and after subscribing to channels but before running yum update?
OR
After yum update before engine-setup?

Thanks!

Comment 8 Emma Heftman 2017-05-21 13:04:32 UTC
(In reply to Marina from comment #3)
> So, basically, I believe we need two additions here to SHE guide:
> 1. After initial deployment, we need a section explaining that HE VM needs
> to be registered to the right channels, after it is up and running, just as
> any other Manager.a

When I looked in the standard Installation Guide, to see how we handle "other Managers" I see section  3.1 which describes how to subscribe to entitlements, but this comes BEFORE the deployment.

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

This is also already mentioned in the Hosted Engine installation guide here, but again, this is done before the deployment:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html/self-hosted_engine_guide/chap-deploying_self-hosted_engine#Deploying_Self-Hosted_Engine_on_RHEL

Also, there is a section about subscribing the hosts to entitlements, which does come POST installation, but this is for hosts, and this meant to be about Managers.
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/installation_guide/#Subscribing_to_Required_Channels_using_Subscription_Manager1

Please clarify which of these you are referring to. 


> 2. In the upgrades section we need to clarify how HE VM should be upgraded.
> Which is exact same as a regular manager. And it can be done, after #1 above
> is done.

Comment 9 Javier Coscia 2017-05-23 12:51:39 UTC
(In reply to Emma Heftman from comment #7)
> (In reply to Emma Heftman from comment #6)
> > (In reply to Javier Coscia from comment #4)
> > > I think we also need to add that the HE RHV-M upgrade needs you to place the
> > > global maintenance to avoid HA agent restart the HE VM in another host in
> > > the HE cluster since engine-setup will restart the service at some point.
> > 
> > Hi Javier
> > Can you please explain what you mean by "HE RHV-M upgrade needs you to place
> > the
> > > global maintenance"
> > 
> > And please provide the precise instructions for doing this.
> > 
> > Thanks
> > Emma
> 
> Javier, I understand what global maintenance is but can you please clarify
> exactly at which stage it should be implemented?
> 
> After deployment and after subscribing to channels but before running yum
> update?
> OR
> After yum update before engine-setup?
> 

Hi Emma, sorry for the delay. The global maintenance should be used before running 'engine-setup', since the upgrade will stop/start the ovirt-engine process and if the HA and broker agents are running, the HE VM will be started on any other host in the HE cluster which could corrupt/break the ovirt upgrade.

Hope it helps.

> Thanks!

Comment 10 Javier Coscia 2017-05-23 13:41:04 UTC
(In reply to Emma Heftman from comment #8)
> (In reply to Marina from comment #3)
> > So, basically, I believe we need two additions here to SHE guide:
> > 1. After initial deployment, we need a section explaining that HE VM needs
> > to be registered to the right channels, after it is up and running, just as
> > any other Manager.a
> 
> When I looked in the standard Installation Guide, to see how we handle
> "other Managers" I see section  3.1 which describes how to subscribe to
> entitlements, but this comes BEFORE the deployment.
> 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/
> html-single/installation_guide/
> #Subscribing_to_the_Red_Hat_Enterprise_Virtualization_Manager_Channels_using_
> Subscription_Manager

Correct, this is the non-SHE installation and it's fine. These are the steps customer will have to do AFTER installing the HE VM through the appliance.

> 
> This is also already mentioned in the Hosted Engine installation guide here,
> but again, this is done before the deployment:
> 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/
> html/self-hosted_engine_guide/chap-deploying_self-
> hosted_engine#Deploying_Self-Hosted_Engine_on_RHEL

The ovirt-hosted-engine-setup and rhevm-appliance are under hosts' repos, not the ones we need for the HE VM to perform the minor upgrades.

> 
> Also, there is a section about subscribing the hosts to entitlements, which
> does come POST installation, but this is for hosts, and this meant to be
> about Managers.
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/
> html-single/installation_guide/
> #Subscribing_to_Required_Channels_using_Subscription_Manager1

Again, these are hosts' repos, so won't be needed inside the HE VM.

> 
> Please clarify which of these you are referring to. 
> 

What I understand from Marina, is that we need to add a separate section in SHE documentation, stating that, once the HE VM appliance is installed/deployed, customer has to register the OS inside the HE VM with the subs/repos from above (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.0/html-single/installation_guide/#Subscribing_to_the_Red_Hat_Enterprise_Virtualization_Manager_Channels_using_Subscription_Manager)

> 
> > 2. In the upgrades section we need to clarify how HE VM should be upgraded.
> > Which is exact same as a regular manager. And it can be done, after #1 above
> > is done.

Let me know if that helps.

Adding NI to Marina to keep me honest/correct me

Comment 11 Emma Heftman 2017-05-24 13:00:44 UTC
Marina/Javier
Another question - Can you confirm whether this procedure is also relevant for 4.1 i.e. minor 4.1 upgrades, or only within 4.0. i.e. 4.1.x > 4.1.y?

Thanks
Emma

Comment 12 Javier Coscia 2017-05-24 13:09:12 UTC
(In reply to Emma Heftman from comment #11)
> Marina/Javier
> Another question - Can you confirm whether this procedure is also relevant
> for 4.1 i.e. minor 4.1 upgrades, or only within 4.0. i.e. 4.1.x > 4.1.y?

Hi Emma, as far as I understand, this would be the procedure for all minor upgrades in SHE environment, this is a 'special' subscription procedure, where customer has to subscribe the HE VM because he didn't do it in the first place when using the appliance. In a deployment where customer install the HE VM OS manually, there won't be a need to do this since he has to subscribe it first in order to install the packages

> 
> Thanks
> Emma

Comment 13 Emma Heftman 2017-05-24 13:31:44 UTC
Javier

Thanks for that clarification. I already have another question :)

when Marina says 
"2. In the upgrades section we need to clarify how HE VM should be upgraded. Which is exact same as a regular manager. And it can be done, after #1 above is done."[Subscribing]


Can we just make a reference to the standard documentation for upgrading minor versions. If they only difference is telling them to subscribe first, we can simply tell them, ensure that you have subscribed then following section 2:

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

We always reference current procedures where possible. Please let me know if there are any other differences except for telling them to subscribe first.

Comment 14 Javier Coscia 2017-05-24 14:15:34 UTC
That sounds right Emma, the only difference between a manually deployed HE VM and one done through the appliance is the subscription steps

Comment 15 Emma Heftman 2017-05-24 14:47:13 UTC
(In reply to Javier Coscia from comment #14)
> That sounds right Emma, the only difference between a manually deployed HE
> VM and one done through the appliance is the subscription steps

Thanks Javier, and can you confirm that we are interested in referencing how to update the Manager and the hosts, i.e. sections 2.1 and 2.2 of the Upgrade guide?

Comment 16 Javier Coscia 2017-05-24 15:19:34 UTC
I think referencing customers to section 2 in the upgrade guide should be enough, this is just my opinion though.