Bug 1352435 - [Docs][All][RFE] Document RHVH functionality
Summary: [Docs][All][RFE] Document RHVH functionality
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
unspecified
unspecified
Target Milestone: ovirt-4.0.1
: ---
Assignee: Tahlia Richardson
QA Contact: Byron Gravenorst
URL:
Whiteboard:
Depends On: ovirt-node-ng 1304617 1318416 1319708
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-07-04 07:46 UTC by Lucy Bopf
Modified: 2016-08-29 12:19 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-08-15 00:20:41 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Lucy Bopf 2016-07-04 07:46:51 UTC
This bug is a tracker for investigating the functionality of Red Hat Virtualization Host, and applying updates to relevant areas in the documentation.

This bug should track:

* Cockpit functionality - Which tasks can/should a user complete using the Cockpit user interface? Which tasks should be completed via the Administration Portal instead?
* What limitations (if any) does RHVH have? This includes updating/removing, if necessary, any existing documentation that describes the limitations of the old RHEV-H.
* Adding technical descriptions of the new host type, and updating any remaining references to RHEV-H and its functionality (particularly in the Technical Reference).


Note:
Installing SHE from the Cockpit user interface is tracked in bug 1350697.
Installing and using the Cockpit user interface plug-in for RHV-M is tracked in bug 1352431.
Addition of boot kernel parameters for RHVH is tracked in bug 1351887.

Comment 1 Lucy Bopf 2016-07-05 05:26:34 UTC
Assigning to Tahlia for review.

Comment 2 Tahlia Richardson 2016-07-19 07:03:08 UTC
Initial assessment (more tasks will probably reveal themselves):

***Admin***
General updates
Add an introductory section back to the Hosts chapter
Second Important box in Reinstalling Virtualization Hosts is probably not relevant anymore
Can RHVH still not be added to Gluster clusters?
"Logical networks imported from external providers are only compatible with Red Hat Enterprise Linux hosts and cannot be assigned to virtual machines running on Red Hat Virtualization Hypervisor hosts." Is this still true?
Local storage: "On Red Hat Virtualization Hypervisors the only path permitted for use as local storage is /data/images. This directory already exists with the correct permissions on Hypervisor installations." Is this still the case, or do the RHEL host steps apply to RHVH now? 
Hooks: "Note that at this time hooks are not able to run on Red Hat Virtualization Hypervisors, they must only be used on Red Hat Enterprise Linux hosts." Still true?
"On the hosts that you want to configure ethtool properties, install the VDSM hook package. The package is available by default on Red Hat Virtualization Hypervisor but needs to be installed on Red Hat Enterprise Linux hosts: # yum install vdsm-hook-ethtool-options" Is this still true? (Seems at odds with the previous point?)
System user accounts: "Red Hat Virtualization Hypervisor hosts also define an admin user (UID 500) that is not created on Red Hat Enterprise Linux virtualization hosts. The admin user is created with the required permissions to run commands as the root user using the sudo command." No longer true? 
* Must also assess whether there are any admin tasks that should be done from the Cockpit portal rather than the Admin Portal - these (if any) would need new procedures. The nice thing about RHVH is that it's been made to be more like RHEL hosts, so in theory there would be less to specifically document.

***Upgrade***
Remove specific RHEV-H section - update is/should be the same as RHEL hosts
Does the upgrade manager still only upgrade selected packages? Is this supported/a good idea?
Using yum on RHVH - limitations? 

***Tech Ref***
1.2. Red Hat Virtualization Hypervisor is somehow still all true and just needs a name change
Update 10.6 Hypervisor Requirements, particularly storage section
Is the Important box about fakeraid devices still relevant? 
Any new/other limitations that should be documented?

***Self-Hosted Engine***
Covered by other bugs

***Other books***
Update references
Update the name when it's confirmed that we can do so

Comment 3 Tahlia Richardson 2016-07-20 03:39:50 UTC
I was right:

***Python SDK***
"2.9. Example: Approving a Host using Python
 Red Hat Virtualization Hypervisor hosts are added to the Red Hat Virtualization Manager during their configuration. Once you have added a Hypervisor it requires approval in the Manager before it can actually be used in the environment.
Example 2.8. Approving a host using Python"
Need to check if this is still applicable

***REST API***
3.7. Example: Approve Host
"Example 3.7. Approve a pre-configured Red Hat Virtualization Hypervisor host"
See if this is still relevant. I suspect not. 
14.6.1. Creating a Host
"Red Hat Virtualization Manager detects hypervisor hosts automatically and requires approval for their use."
14.8.1. Install VDSM Action
"Example 14.29. Action to install VDSM to a Red Hat Virtualization Hypervisor host"
14.8.6. Approve Host Action
"Approve a pre-installed Red Hat Virtualization Hypervisor host for usage in the virtualization environment"
14.1. Host Elements
"type 	One of rhel or rhev-h 	The host type."
See if this still says rhev-h

***Deployment Planning***
1.6. Ways to Access Red Hat Virtualization
"Unsupported Interfaces
Red Hat Virtualization Hypervisor Console
    Console access to Red Hat Virtualization Hypervisor outside of the provided text user interface for configuration is not supported unless explicitly requested by Red Hat Support." See if this is still true (also check on access via Terminal tab of Cockpit - probably fine)
2.2.3. Storage Requirements
Needs to be replaced with the new storage requirements from the Install guide

Comment 4 Tahlia Richardson 2016-07-20 03:41:22 UTC
Name change covered in BZ#1355912.

Comment 5 Tahlia Richardson 2016-07-26 06:34:17 UTC
Tasks completed:
* Added an intro to RHVH in the Hosts chapter of the Admin Guide
* Updated the storage requirements in the Tech Ref and Deployment Planning Guide
* Removed the RHEV-H update procedure and updated the RHEL host update procedures to cover both kinds of hosts

Comment 6 Tahlia Richardson 2016-07-26 06:49:03 UTC
Hi Fabian,
I'm sorting out what exactly needs to be documented for RHVH after the installation is complete. Are there any administrative tasks that: 
* Are done differently for RHVH than for RHEL hosts (I'd expect fewer tasks than before to fall under this, since tasks like upgrading, for example, should now be the same as for RHEL hosts)
* Can only be done from the Cockpit user interface (like hosted engine deployment, tracked in BZ#1350697) 
* Can be done through both Cockpit and Admin Portal, but we would prefer customers to do it through Cockpit (is this likely to be a thing that happens, or do we recommend using the Admin Portal whenever possible (in which case we probably wouldn't document the Cockpit method unless specifically requested)?)

Comment 10 Tahlia Richardson 2016-07-29 06:02:03 UTC
Tasks completed:
* Removed outdated REST API methods/actions
* Removed outdated limitations

Comment 19 Tahlia Richardson 2016-08-15 00:20:41 UTC
Content now published in various guides at https://access.redhat.com/documentation/en/red-hat-virtualization?version=4.0/


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