Bug 1477750 - [HCI] Clarify wording in Configuring 'Geo-replication for Disaster Recovery'
Summary: [HCI] Clarify wording in Configuring 'Geo-replication for Disaster Recovery'
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat Storage
Component: doc-Maintaining_RHHI
Version: unspecified
Hardware: x86_64
OS: Linux
unspecified
medium
Target Milestone: ---
: ---
Assignee: Laura Bailey
QA Contact: RamaKasturi
URL:
Whiteboard:
Depends On:
Blocks: RHHI-1.1-Documentation-Backlog-BZs
TreeView+ depends on / blocked
 
Reported: 2017-08-02 19:54 UTC by Dave
Modified: 2018-01-18 06:11 UTC (History)
12 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-01-03 10:56:01 UTC
Embargoed:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.