Bug 1498293

Summary: Adding a RHEV provider IP does not clearly state what IP/Hostname to add
Product: Red Hat CloudForms Management Engine Reporter: Gilbert Kimetto <gkimetto>
Component: DocumentationAssignee: Dayle Parker <dayleparker>
Status: CLOSED CURRENTRELEASE QA Contact: Suyog Sainkar <ssainkar>
Severity: medium Docs Contact:
Priority: medium    
Version: 5.8.0CC: adahms, cpelland, dajohnso, dayleparker, gblomqui, gkimetto, hhudgeon, jfrey, jhardy, lavenel, obarenbo, ssainkar, trichard
Target Milestone: GA   
Target Release: 5.9.2   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-03-29 08:05:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: RHEVM Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Add_IP_Address none

Description Gilbert Kimetto 2017-10-03 21:13:01 UTC
Description of problem:

The IP address to add is not clear when adding a RHEV provider.

Under Compute -> Infrastructure -> Provider
 When you Click Configuration to add a provider the label says to add an IP.
 What it actually expects is the MSA Hosted Engine IP address and credentials 

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


How reproducible:


Steps to Reproduce:
1.) Under Compute -> Infrastructure -> Provider
2.) When you Click Configuration to add a provider the label says to add an IP.
3.) What it actually expects is the MSA Hosted Engine IP address and credentials 
Actual results:


Expected results:

Should say add the Hosted Engine/MSA IP address

Additional info:

Comment 2 Gilbert Kimetto 2017-10-03 21:13:50 UTC
Created attachment 1333941 [details]
Add_IP_Address

Comment 3 Gilbert Kimetto 2017-10-03 21:25:05 UTC
Needs a doc update as well for "Managing Providers" 


URL:

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html/managing_providers/infrastructure_providers#red_hat_virtualization_providers

1.2.2. Adding a Red Hat Virtualization Provider

Comment 4 Andrew Dahms 2018-03-20 01:05:37 UTC
Assigning to Dayle for review.

Comment 7 Dayle Parker 2018-03-28 01:19:42 UTC
Created attachment 1413940 [details]
Revised procedure for adding a RHV provider

Attached is a screenshot of the procedure with extra clarification.

Comment 8 Dayle Parker 2018-03-28 01:29:46 UTC
I've had a chat with Tahlia Richardson (long-time technical writer for the RHV docs team, CCed) about the terminology and how to make this more clear. 

"MSA Hosted Engine" is not a common term, and doesn't exist in the RHV documentation, and we want to continue to remain consistent with docs for other Red Hat products to avoid confusion for users. The IP address/hostname that should be entered here is that of the RHV Manager (which is not always a self-hosted engine -- it can also be hosted elsewhere). So the change I've made, to provide a bit of extra clarification for users is:

Was:
Enter the Hostname or IPv4 or IPv6 address of the provider. 

Now:
Enter the Hostname or IPv4 or IPv6 address of the Red Hat Virtualization Manager. 

Suyog, would you mind reviewing and letting me know your thoughts on the change, and the issue raised here?

https://github.com/ManageIQ/manageiq_docs/pull/789

And Gilbert, let me know if you have any additional thoughts on this.

Many thanks,
Dayle

Comment 10 Gilbert Kimetto 2018-03-28 15:06:49 UTC
That sounds more informative/clear

Comment 11 Dayle Parker 2018-03-29 08:05:35 UTC
Thanks, Suyog and Gilbert.

I've published this update in the 4.5 and 4.6 guides now in "1.2.2. Adding a Red Hat Virtualization Provider":

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/managing_providers/

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6/html-single/managing_providers/