Bug 1296622

Summary: [SME] Install Quick Start need to include basic PV setup for registry setup
Product: OpenShift Container Platform Reporter: Peter Larsen <plarsen>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.1.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-12-29 03:50:23 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 Peter Larsen 2016-01-07 16:46:33 UTC
Document URL: https://docs.openshift.com/enterprise/3.1/install_config/install/quick_install.html

Section Number and Name: n/a

Describe the issue: 
For a basic install using Quick Start, the guide should include setting up a basic NFS server on the master (or another node) to provision space for the registry.

A separate section that covers basic configuration of PVs (including the backend from a clean install) would work too.

Suggestions for improvement: 

Include instructions for:
1) Enable rpcbind service
2) Enable nfs-server service
3) Add disk for VG to use for storage
4) Create VG and LV for registry
5) mkfs.xfs LV
6) Create mount point /mnt/nfs/registry and /etc/fstab entry for registry volume
7) mount /mnt/nfs/registry
8) Create entry in /etc/exports for /mnt/nfs/registry - run exportfs -r

This could be a part of the installation process too or a separate script we can provide to make it easier for the unexperienced user.

Section for setting up registry should then simply be shorted to use the oc volume and this NFS share. 

Additional information: 

It's important to note, that the quick-start guide is used by non ops and for evaluation purposes. Covering a basic NFS server even though it's never going to be used in production will help a user easily get OSE installed and working with a proper configuration.

Comment 1 Vikram Goyal 2017-12-29 03:50:23 UTC
We added some details on PV creation in the 3.6 release docs: https://docs.openshift.com/container-platform/3.6/getting_started/configure_openshift.html#create-persistent-storage-for-registry

For the rest, we would consider that out of scope. I am going to close this bug, but please feel free to reopen and provide reasoning why.