Bug 1534961

Summary: Users require email for automate methods
Product: Red Hat CloudForms Management Engine Reporter: Vatsal Parekh <vparekh>
Component: DocumentationAssignee: Dayle Parker <dayleparker>
Status: CLOSED CURRENTRELEASE QA Contact: Chris Budzilowicz <cbudzilo>
Severity: high Docs Contact:
Priority: high    
Version: 5.9.0CC: adahms, akarol, ansinha, cbudzilo, cpelland, dajohnso, hhudgeon, obarenbo, vparekh
Target Milestone: GA   
Target Release: 5.9.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-02-08 03:12:17 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: CFME Core Target Upstream Version:
Embargoed:
Attachments:
Description Flags
mandatory e-mail field
none
Creating a user none

Description Vatsal Parekh 2018-01-16 11:23:12 UTC
Document URL: 

Section Number and Name: 

Describe the issue: 
From the latest updates on 5.9z and 5.8.3.1, users are required to have email field else the requests get stuck in 'pending'. I don't find this design change documented yet.
https://bugzilla.redhat.com/show_bug.cgi?id=1531161

Suggestions for improvement: 

Additional information: 


Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 2 Andrew Dahms 2018-01-22 05:00:07 UTC
Assigning to Dayle for review.

Comment 3 Vatsal Parekh 2018-01-22 11:36:30 UTC
I am able to reproduce this on 5.8.3.1 as well, as 5.8.3.1 is update to existing z stream appliances customers would have, this change must be documented.

Comment 4 Dayle Parker 2018-01-30 07:26:03 UTC
Hi Vatsal,

I believe we already have this documented, if I'm understanding this bug correctly: the E-Mail field is required when provisioning a virtual machine (or provisioning gets stuck in 'pending').

It is mentioned to be required in section "2.8.1. Provisioning a Virtual Machine from a Template", in step 5 - https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/html-single/provisioning_virtual_machines_and_hosts/#provisioning-virtual-machines

When I tested this on CloudForms 4.6 Beta, my email address was filled in automatically, and there is a "*" in the UI to show "E-Mail" is a mandatory field. (see the attached screenshot, which I can update for section 2.8.1 for the updated UI)

In another guide, "4.2.5. Creating a User" says to enter an e-mail address when creating a user (along with other fields) -- https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/html-single/general_configuration/#creating_a_user

Is this what you were looking for in the docs? Or is there a better place/way we can clarify this?

Thanks for your help,
Dayle

Comment 5 Dayle Parker 2018-01-30 07:28:47 UTC
Created attachment 1388165 [details]
mandatory e-mail field

Screenshot showing the mandatory email field in CloudForms 4.6 beta when provisioning a VM (see Comment 4)

Comment 6 Vatsal Parekh 2018-01-30 09:45:08 UTC
(In reply to Dayle Parker from comment #4)
> Hi Vatsal,
> 
> I believe we already have this documented, if I'm understanding this bug
> correctly: the E-Mail field is required when provisioning a virtual machine
> (or provisioning gets stuck in 'pending').
> 
> It is mentioned to be required in section "2.8.1. Provisioning a Virtual
> Machine from a Template", in step 5 -
> https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/
> html-single/provisioning_virtual_machines_and_hosts/#provisioning-virtual-
> machines
> 
> When I tested this on CloudForms 4.6 Beta, my email address was filled in
> automatically, and there is a "*" in the UI to show "E-Mail" is a mandatory
> field. (see the attached screenshot, which I can update for section 2.8.1
> for the updated UI)
> 
> In another guide, "4.2.5. Creating a User" says to enter an e-mail address
> when creating a user (along with other fields) --
> https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/
> html-single/general_configuration/#creating_a_user
> 
> Is this what you were looking for in the docs? Or is there a better
> place/way we can clarify this?
> 
> Thanks for your help,
> Dayle

Hey Dayle,
I was trying to point out for provisioning via ordering service catalogs. There email is not asked in the form by default, and if user doesn't have email then the request would stay in pending. 
Adding email is written in doc of creating a user, but its not mandatory to add one; so in such case customer might face this issue.
Not sure exactly where we can put this, but I felt this is important to bring in notice.

Comment 7 Dayle Parker 2018-02-01 08:05:38 UTC
Hey Vatsal,

Thanks for clarifying. I've added a note in what seem to be the two best/most relevant places in the docs:

The notes go in:
"4.2.1.1. Applying User or Group Quotas"
https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/html-single/provisioning_virtual_machines_and_hosts/#quotas

and 

"Creating a user"
https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6-beta/html-single/general_configuration/#creating_a_user

Comment 8 Dayle Parker 2018-02-01 08:06:48 UTC
Created attachment 1389385 [details]
Creating a user

General Config guide addition

Comment 9 Dayle Parker 2018-02-01 08:07:30 UTC
Created attachment 1389386 [details]
Provisioning guide - quota

Provisioning guide addition

Comment 10 Dayle Parker 2018-02-01 08:10:17 UTC
Hey Chris,

I think these two spots are the best locations for this info (not sure if two spots is overkill) -- would you mind reviewing and letting me know what you think? The screenshots align with the links in Comment 7.

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


Thanks so much,
Dayle

Comment 12 Dayle Parker 2018-02-08 03:12:17 UTC
Thanks for reviewing, Chris!

The updates are live in the 4.5 documentation:

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/provisioning_virtual_machines_and_hosts/#quotas

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/general_configuration/#creating_a_user

The updates will also be published in the CloudForms 4.6 GA (MIQ 5.9) docs once they are released.