Bug 1841527

Summary: A.3 Updating a self-hosted engine is missing steps / link to enabling repositories
Product: Red Hat Enterprise Virtualization Manager Reporter: Ian Tewksbury <itewksbu>
Component: DocumentationAssignee: Steve Goodman <sgoodman>
Status: CLOSED DUPLICATE QA Contact: rhev-docs <rhev-docs>
Severity: medium Docs Contact:
Priority: medium    
Version: 4.3.9CC: lsurette, mavital, mhicks, sgoodman, srevivo
Target Milestone: ovirt-4.3.11Keywords: Documentation
Target Release: ---   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-06-29 14:51:44 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 Ian Tewksbury 2020-05-29 11:43:56 UTC
Description of problem:

The Procedure for A.3. UPDATING A SELF-HOSTED ENGINE (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/upgrade_guide/updating_a_self-hosted_engine_minor_updates) subsection "Updating the Red Hat Virtualization Manager" is missing initial steps to confirm subscriptions and repositories enabled.


Version-Release number of selected component (if applicable):
4.3 - https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/upgrade_guide/updating_a_self-hosted_engine_minor_updates
4.4-beta - https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4-beta/html-single/upgrade_guide/index#Updating_a_self-hosted_engine_minor_updates


How reproducible:
Its a doc problem, so always.



Actual results:
One has to hunt around in the documentation to locate 5.2. Enabling the Red Hat Virtualization Manager Repositories (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_cockpit_web_interface/installing_the_red_hat_virtualization_manager_she_cockpit_deploy#Enabling_the_Red_Hat_Virtualization_Manager_Repositories_install_RHVM) to determine the list of subscriptions and repositories that need to be enabled before being able to successfully proceed through the A.3. UPDATING A SELF-HOSTED ENGINE steps.


Expected results:
A.3. UPDATING A SELF-HOSTED ENGINE (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/upgrade_guide/updating_a_self-hosted_engine_minor_updates) instructions should have intiial steps (essentially a copy/include or link to 5.2. Enabling the Red Hat Virtualization Manager Repositories (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_cockpit_web_interface/installing_the_red_hat_virtualization_manager_she_cockpit_deploy#Enabling_the_Red_Hat_Virtualization_Manager_Repositories_install_RHVM) to ensure the RHV-M (self-hosted engine) is subscribed to the correct subs and has the correct repos enabled.

Comment 1 Ian Tewksbury 2020-05-29 11:50:58 UTC
Related: https://bugzilla.redhat.com/show_bug.cgi?id=1841530

Comment 2 Steve Goodman 2020-06-17 08:36:33 UTC
For 4.3.11 there is already the following message:

> Warning
> Be sure to enable the correct repositories as detailed in Prerequisites. Otherwise, the upgrade might fail.

If you go the Prerequisites section, there is a link to the correct section in the install guide.

So I have lowered the priority.

For 4.4 GA, I have addressed this a bit better by adding a Prerequisite section to the topic with the following text (this is the existing text in the Prerequisites section):

- Ensure the Manager has the correct repositories enabled. For the list of required repositories, see Enabling the Red Hat Virtualization Manager Repositories for Red Hat Virtualization 4.4.

This links to:
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4-beta/html-single/installing_red_hat_virtualization_as_a_standalone_manager_with_local_databases/index#Enabling_the_Red_Hat_Virtualization_Manager_Repositories_install_RHVM.

You can see this in the merge request for bug 1802650 in the latest preview for the Upgrade Guide:

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1639

Comment 3 Ian Tewksbury 2020-06-17 11:00:39 UTC
Steve,

Thank you.

Having that link to the right doc with the repos and a distinct section for the prerequisites I think will help a lot.

Blue skies,
Ian

Comment 4 Steve Goodman 2020-06-29 14:51:44 UTC
I'm closing this as a duplicate because I addressed it in the merge request for bug 1802650.

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