Bug 1319513

Summary: [GSS]Doc-bug]Minor corrections on where to execute ceph-deploy
Product: Red Hat Ceph Storage Reporter: Vimal Kumar <vikumar>
Component: DocumentationAssignee: Bara Ancincova <bancinco>
Status: CLOSED CURRENTRELEASE QA Contact: ceph-qe-bugs <ceph-qe-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 1.3.2CC: asriram, kdreyer, ngoswami, nlevine, vikumar
Target Milestone: rcKeywords: Documentation, ZStream
Target Release: 1.3.2   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-04-19 17:16:31 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 Vimal Kumar 2016-03-20 20:15:42 UTC
1) Description of problem:

The RHCS1.3 installation guide in section "2.1. Executing ceph-deploy", mentions the following:

"""When executing ceph-deploy with Red Hat Ceph Storage, ceph-deploy will need to retrieve Ceph packages from the /opt/calamari directory on your Calamari admin host, so you need to ensure that ceph-deploy has access to the .cephdeploy.conf file that was written to ~, /root and your local working directory when you executed ice_setup."""

and 

"""The ceph-deploy utility will output files to the current directory. Ensure you are in this directory when executing ceph-deploy, and ensure that ceph-deploy points to the .cephdeploy.conf file."""

"ceph_deploy" is to be executed after running "ice_setup" from /home/<ceph-user>/ceph-config/. "ice_setup" will create the "cephdeploy.conf" file in /home/<ceph-user>/ceph-config/ and /root/. Since both 'ceph-deploy' and "ice_setup" needs to be run from /home/<ceph-user>/ceph-config/, the file 'cephdeploy.conf' file will definitely be in /home/<ceph-user>/ceph-config/.

Hence, we may need to change the above documentation line which mentions three locations where cephdeploy.conf will be written to (~, /root and your local working directory) to something like:

"""Ensure you execute 'ceph-deploy' inside '/home/<ceph-user>/ceph-config/'. 'ceph-deploy' will read the 'cephdeploy.conf' written to the said directory ('/home/<ceph-user>/ceph-config/') by 'ice_setup', pull the packages from the repositories mentioned in it, and start the installation."""

This will make sure the installation documentation is much easier to read and understand.

2) Version-Release number of selected component (if applicable):

RHCS1.3 Installation documentation

Comment 3 Neil Levine 2016-03-22 19:17:43 UTC
Given this is ceph-deploy I think this bug needs to be assigned to 1.3.2 or 1.3.3. 

Not sure how post-release, doc-only errata are handled in BZ?