Bug 1711895

Summary: [Doc RFE] Add steps to setup geo-replication using gdeploy
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Sachidananda Urs <surs>
Component: doc-Administration_GuideAssignee: Pratik Mulay <pmulay>
doc-Administration_Guide sub component: Default QA Contact: Kshithij Iyer <kiyer>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: high    
Priority: unspecified CC: asriram, kiyer, musoni, nchilaka, nlevinki, pmulay, rhs-bugs, rmusil, rwheeler, srmukher, storage-doc, vdas
Version: rhgs-3.5   
Target Milestone: ---   
Target Release: RHGS 3.5.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Feature: Setting geo-replication using gdeploy. Reason: Currently setting up geo-replication is a manual and tedious process. This process needs to be automated. Result: With gdeploy, setting up geo-replication becomes simple and easy. The process and steps are documented in Comment 0.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2019-11-04 09:47:42 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: 1696812    

Description Sachidananda Urs 2019-05-20 10:35:51 UTC 
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/administration_guide/index#chap-Red_Hat_Storage_Volumes-gdeploy

Section Number and Name: 
N/A 

[New section has to be added]

Describe the issue: 

Setting up geo-replication is a new feature being added to gdeploy in the current release. Documentation for the same has to be added.

Suggestions for improvement: 

Additional information: 

The pre-requisite is to have master and slave volumes created. This can
be done using gdeploy. See the documentation on creating volumes using georep.
To setup geo-replication a configuration file similar to this has to be written:

#
# Usage:
#       gdeploy -c geo-replication.conf
#
# This config sets up geo-replication between the volumes
# `mastervolume' and `slavevolume', by default georep session
# is started, to just create a session and not start it during
# creation set the variable start=no
#
# This sets up the session as user root.
#

[hosts]
10.70.43.219

[geo-replication]
action=create
mastervol=10.70.43.219:mastervolume
slavevol=10.70.43.25:slavesvolume
slavenodes=10.70.43.25,10.70.43.86
force=yes
# start=no

=================

To create a georep secure session, write a config file similar to this:

#
# Usage:
#       gdeploy -c georep-secure.conf
#
# This config sets up secure geo-replication between the volumes
# `mastervolume' and `slavevolume' as user testgeorep, by default
# georep session is started, to just create a session and not start
# it during creation set the variable start=no
#
# This sets up the session as user testgeorep. 
#

[hosts]
10.70.42.122

[geo-replication]
action=create
georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
slavenodes=10.70.43.48,10.70.42.217
force=no
# start=no

=====================

To pause a geo-replication session, write a configuration file similar
to this:

# Pause a geo-replication session
# Usage: gdeploy -c georep-pause.conf

[hosts]
10.70.42.122

[geo-replication]
action=pause
# georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
# force=no

==========================

To resume a paused geo-replication session, config file similar to this
has to be written:

# Resume a geo-replication session
# Usage: gdeploy -c georep-resume.conf

[hosts]
10.70.42.122

[geo-replication]
action=resume
# georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
# force=no

================================
To stop a geo-replication session:

# Stop a geo-replication session
# Usage: gdeploy -c georep-stop.conf

[hosts]
10.70.42.122

[geo-replication]
action=stop
#georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
# force=no

======================================

To start a georeplication session:

# Start a geo-replication session
# Usage: gdeploy -c georep-start.conf

[hosts]
10.70.42.122

[geo-replication]
action=start
georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
# force=no
Comment 4 Anjana Suparna Sriram 2019-07-03 10:16:23 UTC 
*** Bug 1511491 has been marked as a duplicate of this bug. ***
Comment 9 Sachidananda Urs 2019-08-23 13:10:16 UTC 
Pratik, I missed delete, conf, failover, and failback. Adding them here:

# Delete a geo-replication session
# Usage: gdeploy -c georep-delete.conf

[hosts]
10.70.42.122

[geo-replication]
action=delete
georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave

Failover:
[hosts]
10.70.42.122

[geo-replication]
action=failover
georepuser=testgeorep
slavevol=10.70.43.48:slave

Failback:
[hosts]
10.70.42.122

[geo-replication]
action=failback
slavevol=10.70.43.48:slave
mastervol=10.70.42.122:master


Config:

[hosts]
10.70.42.122

[geo-replication]
action=config
slavevol=10.70.43.48:slave
mastervol=10.70.42.122:master
gluster-log-file=<path-to-log-file>

The config can be any of: gluster-log-file, gluster-log-level, log-file,
                     log-level, changelog-log-level, ssh-command,
                     rsync-command, use-tarssh, volume-id, timeout,
                     sync-jobs, ignore-deletes, checkpoint, sync-acls,
                     sync-xattrs, log-rsync-performance, rsync-options,
                     use-meta-volume, meta-volume-mnt
Comment 10 Sachidananda Urs 2019-08-23 13:15:25 UTC 
Pratik please ignore failover, failback, and config. Please update the delete.

This part:

=============
# Delete a geo-replication session
# Usage: gdeploy -c georep-delete.conf

[hosts]
10.70.42.122

[geo-replication]
action=delete
georepuser=testgeorep
mastervol=10.70.42.122:master
slavevol=10.70.43.48:slave
>>>>>>>>>>>>>>>>>

That should be enough.
Comment 13 Mugdha Soni 2019-08-26 09:58:21 UTC 
In reply to comment#12 
The information in section"10.5.3" looks good to me .Using these sample files the scripts were created,ran and they worked.
The information in section " 5.7.1" looks good to me 

The bug can be moved to verified state.