Bug 874708 - Update channel information for RHEV 3.1 release in all guides.
Summary: Update channel information for RHEV 3.1 release in all guides.
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
urgent
urgent
Target Milestone: ---
: ---
Assignee: Cheryn Tan
QA Contact: ecs-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-11-08 17:25 UTC by Stephen Gordon
Modified: 2014-06-18 07:52 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-12-04 17:20:27 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Stephen Gordon 2012-11-08 17:25:59 UTC
Description of problem:

Due to issues facing existing customers as the result of RHEV 3.1 being delivered using the same software channel as RHEV 3.1 a new channel is now to be used instead.

The following guides refer to the "rhel-x86_64-server-6-rhevm-3" or "Red Hat Enterprise Virtualization Manager (v.3 x86_64)" channel used for 3.0:

Administration Guide
Command Line Shell Guide
Developer Guide
Evaluation Guide
Installation Guide 
Quick Start Guide
Power User Portal Guide
User Portal Guide

These guides will all need to be updated to include the correct channel information.

I would estimate changing and rebuilding the English language versions will take 1-2 days of effort from ECS, plus QE. Localization will need to update the strings in Zanata and rebuild the Japanese copies of the guides.

An additional half day will be required to ensure a successful rhevm-doc build is available once all changes to the guides are complete.

Comment 1 Stephen Gordon 2012-11-08 21:42:50 UTC
At the time of writing I still have no details on what the new channel will be called so I guess we will have to wait on this activity.

Comment 2 Stephen Gordon 2012-11-08 23:04:56 UTC
An additional impact to consider:

As well as the find and replace above an additional step needs to be added to the upgrade steps in the installation guide (consider this a note to myself not to forget this).

Currently the only additional channel to add when upgrading is the supplementary channel, used for virtio-win. When upgrading it will now also be necessary to add the "new" channel - while leaving the "old" channel enabled for rhevm-upgrade. This wont be picked up by find and replace and needs to be written into the content.

Comment 3 Stephen Gordon 2012-11-12 22:04:47 UTC
I haven't made any progress yet. I spent the day pushing the refresh,
trying to keep up with 4 products that are entering RC phases, and
bootstrapping the new EC2 region where 3 product groups are blocking on
me to complete that task.

I've asked Mike to assist with this task since I will not get to it in a
few days. I'm aware that the new RHN labels will be:

rhel-x86_64-server-6-rhevm-3.1
rhel-x86_64-server-6-rhevm-3.1-debuginfo

The CDN repos will follow once those are created. Please direct your
status requests to him unless he is unavailable.

- Jay

Comment 4 Stephen Gordon 2012-11-12 22:06:31 UTC
So, replace:

"rhel-x86_64-server-6-rhevm-3" with "rhel-x86_64-server-6-rhevm-3.1".

"Red Hat Enterprise Virtualization Manager (v.3 x86_64)" with "Red Hat Enterprise Virtualization Manager (v.3.1 x86_64)"

Comment 5 Zac Dover 2012-11-13 05:54:51 UTC
Quick Start Guide
-----------------
$ cd en-US
$ rpl rhel-x86_64-server-6-rhevm-3 rhel-x86_64-server-6-rhevm-3.1 *

Committed revision 86680.

Comment 6 Zac Dover 2012-11-13 06:04:03 UTC
Quick Start Guide
-----------------
$ cd en-US
$ rpl "Red Hat Enterprise Virtualization Manager (v.3 x86_64)" "Red Hat Enterprise Virtualization Manager (v.3.1 x86_64)" *

Committed revision 86681.

Comment 7 Zac Dover 2012-11-13 06:07:07 UTC
Eval Guide
----------
$ cd en-US
$ rpl rhel-x86_64-server-6-rhevm-3 rhel-x86_64-server-6-rhevm-3.1 *
$ rpl "Red Hat Enterprise Virtualization Manager (v.3 x86_64)" "Red Hat Enterprise Virtualization Manager (v.3.1 x86_64)" *

Committed revision 86682.

Comment 8 Zac Dover 2012-11-13 06:31:44 UTC
User Portal Guide       - no documentation impact
Power User Portal Guide - no documentation impact

Comment 9 Stephen Gordon 2012-11-13 21:28:56 UTC
Discussed with Zac, there are still changes missing in the Eval and Quick Start Guides + at least some of the changes were not merged to 3.1-FINAL.

Additionally I am still trying to clarify the name of the repository to enable when using RHSM (the RHSM discussion may lead to further edits being required in all impacted guides - it depends which, if any, repository is made the default).

Comment 11 Dan Macpherson 2012-11-14 04:19:24 UTC
RHN channel names changed in Developer Guide and Command Shell Guide

Comment 12 Stephen Gordon 2012-11-14 20:07:21 UTC
Have discussed further with Release Engineering and there is one further impact for guides that deal with RHSM. As well as subscribing to the "Red Hat Enterprise Virtualization" entitlement it is necessary to enable the "rhel-6-server-rhevm-3.1-rpms" repository.

This additional step is accomplished using yum-config-manager:

# yum-config-manager --enablerepo=rhel-6-server-rhevm-3.1-rpms

I found that for the most part the guides either don't refer to RHSM at all (Quick Start, Eval) or couch it in generically enough that the above doesn't really apply (Developer, Administration). Given the timeframe I don't think we have the opportunity to expand these to better cover RHSM without throwing yet more spanners in the translation workflow so...

I'm updating the Command Line Shell and Installation Guides with this additional step. I will then proceed to build an updated rhevm-doc package.

Comment 13 Stephen Gordon 2012-11-14 20:41:06 UTC
Red_Hat_Enterprise_Virtualization-Command_Line_Shell_Guide-3.1-web-en-US-1-12.el6eng
Red_Hat_Enterprise_Virtualization-Installation_Guide-3.1-web-en-US-3.1.0-19.el6eng

Comment 14 Stephen Gordon 2012-11-14 20:45:52 UTC
I added a note to the master translation ticket for the Installation Guide, can the authors of the other guides ensure they do the same for theirs?

Comment 15 Tim Hildred 2012-11-15 07:54:38 UTC
The Administration Guide is actually unaffected by this change. 

We don't cover specific channels requirements there, leaving them instead for the Installation Guide.  

As a side note, I'm going to add the "Upgrading to Red Hat Enterprise Virtualization 3.1" content from the Installation Guide to the Administration Guide, and that'll get whatever changes you make to it, Steve.

Comment 17 Stephen Gordon 2012-11-15 15:59:12 UTC
Tim, the Administration Guide impact listed is because when I grep the old channel information in 3.1-FINAL this comes up:

Administration_Guide/en-US/topics/Utilities_USB_filter_editor.xml:		Download the <filename>USBFilterEditor.msi</filename> file from the <literal>Red Hat Enterprise Virtualization Manager (v.3 x86_64)</literal> channel of the Red Hat Network.

Similarly Zac I still see these references in UP and PUP:

Power_User_Portal_Guide/en-US/Using_Desktops_Advanced.xml:			 	 			On a Windows client machine, install the <filename>RHEV-USB-Client.exe</filename>. This package can be obtained from the <literal>Red Hat Enterprise Virtualization Manager (v.3 x86_64)</literal> channel on the Red Hat Network, under the <literal>Downloads</literal> list. 
User_Portal_Guide/en-US/Using_Desktop.xml:			 	 			On a Windows client machine, install the <filename>RHEV-USB-Client.exe</filename>. This package can be obtained from the <literal>Red Hat Enterprise Virtualization Manager (v.3 x86_64)</literal> channel on the Red Hat Network, under the <literal>Downloads</literal> list.

Comment 19 Zac Dover 2012-11-16 02:24:35 UTC
There was also a reference to v.3 in the staged Eval Guide. Not anymore.


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