Bug 1172295 - RHEV 3.4 Admin guide references Openstack components
Summary: RHEV 3.4 Admin guide references Openstack components
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Tahlia Richardson
QA Contact: Andrew Burden
URL:
Whiteboard:
Depends On:
Blocks: 1200186
TreeView+ depends on / blocked
 
Reported: 2014-12-09 19:26 UTC by Rick Beldin
Modified: 2015-04-29 05:39 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22720, Administration Guide-3.4-1.0 Build Date: 09-12-2014 12:45:52 Topic ID: 30335-634252 [Specified]
Last Closed: 2015-04-29 05:39:55 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Rick Beldin 2014-12-09 19:26:18 UTC
Title: Assigning Security Groups to VNIC Profiles

Describe the issue:

Reference to Openstack in the middle of RHEV documentation. 

Why would someone using RHEV have any knowledge of neutron?  

Suggestions for improvement:

Fix this note: 

A security group is identified using the ID of that security group as registered in the OpenStack network service. You can find the IDs of security groups for a given tenant by running the following command on the system on which the OpenStack network service is installed:

# neutron security-group-list

Make it apply to RHEV. 

Additional information:

Comment 1 Andrew Dahms 2015-02-03 14:13:33 UTC
Hi Rick,

Thank you for raising this bug.

The content in question refers to the integration of OpenStack with RHEV, and is a feature that is only available through this integration.

As such, we can't take the content out because it describes how to use this functionality, but perhaps there is a way we can clarify what is happening here.

Do you have any preferences?

Kind regards,

Andrew

Comment 2 Rick Beldin 2015-02-03 15:15:38 UTC
I think the documentation for RHEV needs to be about RHEV.   If there are overlaps with other products, then it should be exceeding clear that these are not about the base product, but only when another product is involved.  Any of these areas need to be highlighted and clearly documented as not being applicable to RHEV.   Similarly,  I would expect OpenStack documentation to have segments that are only applicable when you have certain elements in the mix such as RHEV.   Unless you clearly delineate what is what,  you have a mix of commands that don't match.  

The user manual on my Mazda, for example, talks about 3 different radio models in the section about the radio, but it is clear which controls apply to which model.  They don't just have them all mushed together.

Comment 3 Andrew Dahms 2015-02-26 01:19:10 UTC
Hi Rick,

Thank you for your response, and my apologies for the delay in getting back to you.

Rather than an overlap between Red Hat Enterprise Virtualization and Red Hat Enterprise Linux OpenStack Platform as such, security groups are a feature that RHEV users can only access when they add a RHEL-OSP environment as an external provider.

A description of external providers and the functionality they provide is presented in Chapter 13. of the Administration Guide - https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html-single/Administration_Guide/index.html#chap-External_Providers

As such, while security groups and several other features do indeed relate to RHEL-OSP, they are presented in the Administration Guide as a reference to users looking to harness the capabilities of RHEL-OSP as integrated into their RHEV environment.

While the note on security groups does contain some text designed to explain that security groups are only available on these imported networks, what kind of clarification do you feel we can add here to help users understand that this feature is only available through this integration?

Please let me know what you think.

Kind regards,

Andrew

Comment 4 Rick Beldin 2015-03-09 13:16:10 UTC
While the information about neutron is in a 'look here' text box, there is nothing about it to indicate it is *only* for RHEV.   Perhaps change the 
wording to be clearer about that: 

NOTE

If you are using RHEV with OpenStack, you might want to consider the following:

A security group is identified using the ID of that security group as registered in the OpenStacnetwork service. You can find the ID s of security groups for a given tenant by running the
following command on the system on which the OpenStack network service is installed:

Without a little preface, it seems like this little bit of text is just plopped down in the middle of the document.

Comment 5 Andrew Dahms 2015-03-10 05:18:25 UTC
Hi Rick,

Thank you for your reply.

Understood - we will add a note to the section to help clarify this distinction.

Kind regards,

Andrew

Comment 6 Andrew Dahms 2015-03-10 05:19:09 UTC
Assigning to Tahlia for review.


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