Bug 1477750

Summary: [HCI] Clarify wording in Configuring 'Geo-replication for Disaster Recovery'
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Dave <dfitzpat>
Component: doc-Maintaining_RHHIAssignee: Laura Bailey <lbailey>
Status: CLOSED CURRENTRELEASE QA Contact: RamaKasturi <knarra>
Severity: medium Docs Contact:
Priority: unspecified    
Version: unspecifiedCC: annair, asriram, avishwan, bturner, dfitzpat, knarra, rhs-bugs, sabose, sankarshan, sasundar, storage-doc, storage-qa-internal
Target Milestone: ---   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-01-03 10:56:01 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:
Bug Depends On:    
Bug Blocks: 1491680    

Description Dave 2017-08-02 19:54:48 UTC
Document URL: https://access.redhat.com/documentation/en-us/red_hat_hyperconverged_infrastructure/1.0/html-single/maintaining_red_hat_hyperconverged_infrastructure/#configuring_geo_replication_for_disaster_recovery

Section Number and Name: 3.1.1 CONFIGURING GEO-REPLICATION FOR DISASTER RECOVERY - Before you Begin

Describe the issue: 
"Prepare a remote backup volume to hold the geo-replicated copy of your local volume." <-- 'backup volume' please specify if this is the volume on the master or the slave/ROBO POD

"Ensure that the volume you want to back up has shared storage enabled." <-- 'the volume' please specify if this is the volume on the master or the slave/ROBO POD

"Ensure that your remote backup volume has sharding enabled." <-- "remote backup volume" please specify if this is the volume on the master or the slave/ROBO POD

Suggestions for improvement: 
"Prepare a remote backup volume, located on the slave/ROBO POD, to hold the geo-replicated copy of your local volume located on the master."

"Ensure that the volume you want to back up has shared storage enabled."

"Ensure that your remote backup volume, located on the slave/ ROBO POD has sharding enabled."

Additional information: 
Keeping this very specific will minimize confusion for customers
the phrase ' located on the slave/ ROBO POD' could either be included with commas, parentheses or general rewording 

Rewording this whole section to specify where each volume is located explicitly will do a lot to keep the user from getting confused.

Also explicitly stating where to execute the commands in the section feels needed as well. As of now there's no mention of a statement like "Run the following command on one machine that is in the master group of machines" or any indication if any commands need to be run on multiple systems or just one.

Comment 8 Dave 2017-11-03 19:38:42 UTC
At the risk of being nit picky is the term "local volume" explained as the volume on the POD anywhere in this document? This is in reference to "Prepare a remote backup volume to hold the geo-replicated copy of your local volume." I know it sounds too explicit but having it say the local volume, located on the POD would leave no room for being misunderstood. Thanks,Dave

Comment 9 Laura Bailey 2017-11-06 02:19:19 UTC
Good point, will do some tweaking here.

Comment 14 Dave 2017-11-07 14:14:12 UTC
Looks good to me.
Thanks,
Dave

Comment 15 RamaKasturi 2017-11-21 12:51:15 UTC
Verified in the link provided in comment 13 and the changes looks good to me.