Bug 1332711

Summary: [DOCS] OpenID variables unclear
Product: OpenShift Container Platform Reporter: Eric Jones <erjones>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.2.0CC: aos-bugs, erich, erjones, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: 3.10-release-plan
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-05-28 05:27:22 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Eric Jones 2016-05-03 21:16:44 UTC 
Document URL: 
https://access.redhat.com/documentation/en/openshift-enterprise/version-3.1/installation-and-configuration/#Google

Section Number and Name: 
8.2.11. OpenID Connect

Describe the issue: 
There are four variables defined in this section: sub, preferred_username, email, and name. These are not well defined, leaving it not very clear as to the difference between sub and preferred_username and how one should set these up as the examples simply list them off again without changing any variables (if they are changeable).

Suggestions for improvement: 
Gain clarity around this section of the documentation.
Comment 3 brice 2018-05-18 01:46:08 UTC 
PR created for this BZ:

https://github.com/openshift/openshift-docs/pull/9390

I've tagged Jordan Liggitt for a review to make sure the info is accurate. If there's more thoughts, please let me know.
Comment 4 openshift-github-bot 2018-05-25 01:16:14 UTC 
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/c9d4d834e5193cbe913a188468d222cff977b3b3
Merge pull request #9390 from bfallonf/openid_1332711

Bug 1332711 Added more info to openID auth topic
Comment 5 brice 2018-05-28 05:27:22 UTC 
Link to released docs:

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.9/html-single/installation_and_configuration/#OpenID