Bug 2020448 - RHV 4.4 install page suggests to use Cockpit, documentation shows Cockpit is deprecated
Summary: RHV 4.4 install page suggests to use Cockpit, documentation shows Cockpit is ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.4.8
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ovirt-4.4.10
: ---
Assignee: Eli Marcus
QA Contact: Wei Wang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-11-04 21:44 UTC by Jason Woods
Modified: 2021-11-29 22:43 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-29 22:43:05 UTC
oVirt Team: Integration
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHV-43927 0 None None None 2021-11-04 21:45:27 UTC

Description Jason Woods 2021-11-04 21:44:55 UTC
Description of problem:
RHV 4.4 Documentation issue
In the RHV 4.4 hosted engine installation documentation, it calls out that Cockpit HE install is deprecated, yet the main Install RHV 4.4 page calls out to use Cockpit to install it. If Cockpit is deprecated, we should promote using the command line for installation of HE, not Cockpit.

NOTE
Using Cockpit to install the self-hosted engine is deprecated. Support for this installation method will be removed in a later release.Main RHV install page:
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_cockpit_web_interface/pr01

Deploy and configure the self-hosted engine
Run the installation on the deployment host. The Manager is created on a Red Hat Enterprise Linux virtual machine. Read Deploying the Self-hosted Engine using Cockpit for full details.
https://access.redhat.com/products/red-hat-virtualization/#getstarted

Cockpit HE install is also listed before command line in the same page for:
* Additional resources *
Product Guide
Planning and Prerequisites Guide
- Installing Red Hat Virtualization as a self-hosted engine using the Cockpit web interface
Installing Red Hat Virtualization as a self-hosted engine using the command line
Upgrade Guide
RHEL Registration Assistant


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


How reproducible:
100%


Steps to Reproduce:
1. View RHV 4.4 self hosted manager install web page
https://access.redhat.com/products/red-hat-virtualization/

2. Web page suggests to use Cockpit, but should suggest command line installation.

3. 


Actual results:
Customer is confused which method is suggested.


Expected results:
Web page suggests only using command line installation.


Additional info:

Comment 1 Eli Marcus 2021-11-07 15:40:50 UTC
Hi Jason, 
Thank you for pointing this out - 
- our writing team does not have editing access to the Product page https://access.redhat.com/products/red-hat-virtualization/#getstarted
so, we need to make a formal request to have those links changed, and it may take a few weeks to get it done.

- in the main body of the documentation, I will update and remove the relevant references. 
- on the RHV documentation splash page, we will remove the link to the Cockpit SHE installation method




(In reply to Jason Woods from comment #0)
> Description of problem:
> RHV 4.4 Documentation issue
> In the RHV 4.4 hosted engine installation documentation, it calls out that
> Cockpit HE install is deprecated, yet the main Install RHV 4.4 page calls
> out to use Cockpit to install it. If Cockpit is deprecated, we should
> promote using the command line for installation of HE, not Cockpit.
> 
> NOTE
> Using Cockpit to install the self-hosted engine is deprecated. Support for
> this installation method will be removed in a later release.Main RHV install
> page:
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html/installing_red_hat_virtualization_as_a_self-
> hosted_engine_using_the_cockpit_web_interface/pr01
> 
> Deploy and configure the self-hosted engine
> Run the installation on the deployment host. The Manager is created on a Red
> Hat Enterprise Linux virtual machine. Read Deploying the Self-hosted Engine
> using Cockpit for full details.
> https://access.redhat.com/products/red-hat-virtualization/#getstarted
> 
> Cockpit HE install is also listed before command line in the same page for:
> * Additional resources *
> Product Guide
> Planning and Prerequisites Guide
> - Installing Red Hat Virtualization as a self-hosted engine using the
> Cockpit web interface
> Installing Red Hat Virtualization as a self-hosted engine using the command
> line
> Upgrade Guide
> RHEL Registration Assistant
> 
> 
> Version-Release number of selected component (if applicable):
> RHV 4.4
> 
> 
> How reproducible:
> 100%
> 
> 
> Steps to Reproduce:
> 1. View RHV 4.4 self hosted manager install web page
> https://access.redhat.com/products/red-hat-virtualization/
> 
> 2. Web page suggests to use Cockpit, but should suggest command line
> installation.
> 
> 3. 
> 
> 
> Actual results:
> Customer is confused which method is suggested.
> 
> 
> Expected results:
> Web page suggests only using command line installation.
> 
> 
> Additional info:

Comment 2 Eli Marcus 2021-11-09 16:54:56 UTC
new PR: https://github.com/oVirt/ovirt-site/pull/2626

need to check for broken links in the Upgrade Guide and Installation SHE using command line guide

Comment 3 Eli Marcus 2021-11-15 13:26:30 UTC
Removed link to SHE Cockpit Install document in the upstream oVirt documentation site
https://github.com/oVirt/ovirt-site/pull/2628

Comment 4 Eli Marcus 2021-11-17 13:29:20 UTC
all content and links to Cockpit SHE installation in the main documentation have been removed.

Links in the product page https://access.redhat.com/products/red-hat-virtualization/#getstarted need to be changed by someone who has admin access to those pages.

Comment 5 ctomasko 2021-11-29 22:10:38 UTC
@emarcus the RHV Product Page (https://access.redhat.com/products/red-hat-virtualization/#getstarted) was updated. A few references to cockpit remain in the documentation. Would you please investigate the following:
Are these references are still valid? 

Registering RHVS with Red Hat Satellite 6 instructs users to log in to the Cockpit web interface. https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/index#Enabling_the_RHVH_repository_SHE_deployment_host

4.1 Installing RHV Hosts. Cockpit web interface and link to cockpit project. https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/index#Installing_Red_Hat_Virtualization_Hosts_SHE_deployment_host

Comment 6 Eli Marcus 2021-11-29 22:43:05 UTC
all done - everything is in place and looks good


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