Bug 1703095

Summary: [DOCS] Installation fails with the following problem -> The PersistentVolume "BS31369_ocp_registry-volume" is invalid: [...] a DNS-1123 subdomain must consist of lower case alphanumeric characters, '-' or '.'
Product: OpenShift Container Platform Reporter: Candace Sheremeta <cshereme>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED CURRENTRELEASE QA Contact: Anping Li <anli>
Severity: high Docs Contact: Vikram Goyal <vigoyal>
Priority: low    
Version: 1.0.0CC: aos-bugs, bleanhar, cshereme, erich, gpei, jokerman, misalunk, mmccomas, sdodson, vigoyal, wsun
Target Milestone: ---   
Target Release: 3.7.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: 3.7-release-plan
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 1488366 Environment:
Last Closed: 2020-04-10 22:11:02 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1488366    
Bug Blocks:    

Comment 1 Candace Sheremeta 2019-04-25 13:52:50 UTC 
I have cloned BZ1488366 as a docs bug because the resolution to BZ1488366 needs to be included in the docs, as well. This is for all versions of OpenShift (or, at least, 3.7+).

The resolution of BZ1488366 was to add the following text to the example inventory file that is shipped with the openshift RPMs (in 3.7, /usr/share/doc/openshift-ansible-docs-3.7.0/docs/example-inventories/hosts.example):

# nfs_directory must conform to DNS-1123 subdomain must consist of lower case
# alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character
#openshift_hosted_registry_storage_nfs_directory=/exports

This requirement is still the case in 3.11, but it is not in the documentation at all, so customers who are not specifically looking at the example inventory files shipped with the RPMs (which is probably most of them) will not see this. 

I will leave it up to the professionals on how/where to do this, but the following sections are where we may want to start with this sort of information:

https://docs.openshift.com/container-platform/3.11/install/configuring_inventory_file.html#advanced-install-cluster-metrics-storage

https://docs.openshift.com/container-platform/3.11/install/configuring_inventory_file.html#advanced-installation-logging-storage

https://docs.openshift.com/container-platform/3.11/install/configuring_inventory_file.html#advanced-install-registry-storage

https://docs.openshift.com/container-platform/3.11/install/configuring_inventory_file.html#configuring-oab-storage
Comment 2 Candace Sheremeta 2019-08-16 13:47:13 UTC 
https://github.com/openshift/openshift-docs/pull/16280