Bug 1489750

Summary: [GSS] [RHHI] Few Improvement in geo-replication section
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Bipin Kunal <bkunal>
Component: doc-Maintaining_RHHIAssignee: Apurva Bhide <abhide>
Status: CLOSED CURRENTRELEASE QA Contact: SATHEESARAN <sasundar>
Severity: high Docs Contact:
Priority: unspecified    
Version: rhhi-1.0CC: abhide, asriram, avishwan, rcyriac, rhs-bugs, sankarshan, sasundar, storage-doc, storage-qa-internal
Target Milestone: ---   
Target Release: RHHI-V 1.5   
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: 2019-02-15 10:07:52 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: 1532732    

Description Bipin Kunal 2017-09-08 09:33:50 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_hyperconverged_infrastructure/1.0/html/maintaining_red_hat_hyperconverged_infrastructure/configure_disaster_recovery_using_geo_replication

Section Number and Name: CHAPTER 3. CONFIGURE DISASTER RECOVERY USING GEO-REPLICATION

Describe the issue: 

Suggestions for improvement: 
1) section 3.1.1. Before you begin :
   It is mentioned that 
         "
           If encryption is enabled on the storage that you want to back up, 
           encryption must also be enabled on your remote backup volume.
         "
  
   Suggestion : Add more details on why it is needed for remote backup volume

2) section 3.1.2. Configuring a geo-replication session
  a) "1. Create (but do not start) the geo-replication session"
   
   This section prohibits user to start geo-rep section using CLI but there is no where information about "how/when to start". 

   Suggestion : Please add information on when to restart and how to restart geo-replication.

  b) 2. Configure a meta-volume for your remote backup
    Why we need this steps explicitly ? I think this gets covered as a part of geo-replication configuration. 
    
    Suggestion : Please remove this point if it is not needed explicitly.

3) section 3.1.3. Configuring synchronization schedule
    a) Section heading is not very clear. I would prefer to name it as "Schedule /scheduling geo-replication"
   
   Suggestion : Please change the section name if you agree to my point and Please add few lines on the top about motive of this section.


    b) ii) In the Recurrence field, select a recurrence interval type.
          Valid values are WEEKLY with at least one weekday checkbox selected, 
          or DAILY.

     To me this line is not very clear. If I schedule for weekly, will it run once every week ? If yes, for how many hours? Or what is the criteria for it to be running?

    Suggestion: Please add few more line on what will happen if we set it to weekly or daily or monthly and more information on criteria for it to be running, when will it stop etc.

    c) 4. Check the Events pane at the time you specified to verify that synchronization works correctly.

    Suggestion : Please add few more information on what is expected in "Events pane" here


4) section 3.1.4. Deleting synchronization schedule
   Suggestion : Please add few line on what will happen on deletion. Add information that this will only delete geo-rep/synchronization schedule and not the geo-rep session. Please add information about what will happen to geo-rep session after deletion, will it be in stopped state or active state?

5) 3. (Optional) Remove the geo-replication session

    Here we mention 
       "
           You can also run this command with the reset-sync-time parameter. For 
           further information about this parameter and geo-replication in 
           general, see the Red Hat Gluster Storage Administration Guide
       "

     Either remove the line "You can also run this command with the reset-sync-time parameter." or more information about this parameter here before directing to the other doc/section.
     We have plenty of parameters which can be used, but we have explicitly mentioned "reset-sync-time" here, So I beleive that we should add some more information about this here it self.

Comment 10 SATHEESARAN 2018-07-24 08:20:56 UTC
content looks good