Bug 1474839

Summary: Misleading description in section 21.9 Persistent Storage using Fibre Channel
Product: OpenShift Container Platform Reporter: Pierangelo Magli <pmagli>
Component: DocumentationAssignee: Gaurav Nelson <gnelson>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.5.0CC: aos-bugs, erjones, gnelson, jokerman, lxia, mmccomas
Target Milestone: ---   
Target Release: ---   
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: 2017-10-18 01:05:24 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:
Embargoed:

Description Pierangelo Magli 2017-07-25 13:32:33 UTC
Document URL: https://access.redhat.com/documentation/en-us/openshift_container_platform/3.5/html-single/installation_and_configuration/#install-config-persistent-storage-persistent-storage-fibre-channel

Section Number and Name: 21.9.2 Provisioning (sub-section of 21.9 Persistent Storage using Fibre Channel)

Describe the issue: Both the text and the example provided in this section are misleading. The text states: "Note, the number of LUNs must correspond to the number of Persistent Volumes that are created. In the example below, we have LUN as 2, therefore we have created two Persistent Volume definitions." and then in the pictures below there are 2 PVs shown, both backed by LUN 2.
However, the text above does not make sense... The LUN parameter in the YAML description is the LUN ID, which is defined by the SAN administrator when the LUN is created. Suppose the SAN admin gives us a LUN with ID = 100. Does that mean, citing the sentence above, that "we have LUN as 100, therefore we have created 100 PV definitions"?

Suggestions for improvement: I would remove the text "In the example below, we have LUN as 2, therefore we have created two Persistent Volume definitions.", and remove also the second picture (i.e. the one referencing pv0002). Then, I would stress that there is a 1-1 mapping between a persistent volume and a LUN (it's stated later in section 21.9.2.1. ENFORCING DISK QUOTAS).

Additional information: 


Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 1 Gaurav Nelson 2017-10-03 05:16:57 UTC
*** Bug 1474828 has been marked as a duplicate of this bug. ***

Comment 2 Gaurav Nelson 2017-10-04 00:37:43 UTC
*** Bug 1489493 has been marked as a duplicate of this bug. ***

Comment 3 Gaurav Nelson 2017-10-04 00:47:06 UTC
Updates are in PR https://github.com/openshift/openshift-docs/pull/5301

Comment 4 Liang Xia 2017-10-10 08:06:19 UTC
The doc change LG from QE's perspective.

Comment 5 openshift-github-bot 2017-10-13 05:06:32 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/9c208a1966a905784632780c2aff33c9af4a26ea
fixes for bugs: 1489493, 1489483, 1474839, and 1489497