Bug 1320420

Summary: [Doc RFE] Update Georeplication Chapter with interval/periodically feature
Product: Red Hat Gluster Storage Reporter: Anjana Suparna Sriram <asriram>
Component: doc-Administration_GuideAssignee: Divya <divya>
doc-Administration_Guide sub component: Default QA Contact: Rahul Hinduja <rhinduja>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: unspecified    
Priority: unspecified CC: asriram, avishwan, mhideo, nlevinki, rcyriac, rhinduja, rhs-bugs, rwheeler, storage-doc
Version: rhgs-3.1Keywords: Documentation, FutureFeature, ZStream
Target Milestone: ---   
Target Release: RHGS 3.1.3   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-06-29 14:20:39 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:
Bug Depends On: 1209521    
Bug Blocks: 1311845    

Comment 4 Divya 2016-05-02 08:30:53 UTC
Hi Aravinda,

I have added a new section "14.6. Scheduling Geo-replication as a Cron Job" in the geo-replication chapter to document this feature. 

I have created the content based on the GIT link you shared. Link to the latest documentation: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/563/artifact/tmp/en-US/html-single/index.html#chap-Managing_Geo-replication-Schedule_Cron_Job 

Please review and provide feedback.

Need inputs for the following questions:

- Do I have to document any warning/note to the users if they are using geo-replication as a cron job.

- Could you provide the use cases for this feature.

Comment 5 Aravinda VK 2016-05-04 08:39:03 UTC
(In reply to Divya from comment #4)
> Hi Aravinda,
> 
> I have added a new section "14.6. Scheduling Geo-replication as a Cron Job"
> in the geo-replication chapter to document this feature. 
> 
> I have created the content based on the GIT link you shared. Link to the
> latest documentation:
> http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-
> Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/563/
> artifact/tmp/en-US/html-single/index.html#chap-Managing_Geo-replication-
> Schedule_Cron_Job 
> 
> Please review and provide feedback.
> 
> Need inputs for the following questions:
> 
> - Do I have to document any warning/note to the users if they are using
> geo-replication as a cron job.
> 
> - Could you provide the use cases for this feature.

I am unable to open the link, getting 404 error

Comment 6 Divya 2016-05-04 08:42:59 UTC
(In reply to Aravinda VK from comment #5)
> (In reply to Divya from comment #4)
> > Hi Aravinda,
> > 
> > I have added a new section "14.6. Scheduling Geo-replication as a Cron Job"
> > in the geo-replication chapter to document this feature. 
> > 
> > I have created the content based on the GIT link you shared. Link to the
> > latest documentation:
> > http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-
> > Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/563/
> > artifact/tmp/en-US/html-single/index.html#chap-Managing_Geo-replication-
> > Schedule_Cron_Job 
> > 
> > Please review and provide feedback.
> > 
> > Need inputs for the following questions:
> > 
> > - Do I have to document any warning/note to the users if they are using
> > geo-replication as a cron job.
> > 
> > - Could you provide the use cases for this feature.
> 
> I am unable to open the link, getting 404 error

Could you try the following link:

http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/569/artifact/tmp/en-US/html-single/index.html#chap-Managing_Geo-replication-Schedule_Cron_Job

Comment 7 Aravinda VK 2016-05-04 11:35:45 UTC
Thanks, Now I am able to access the page.

Comments:

We can add about `--help` option
# python /usr/share/glusterfs/scripts/schedule_georep.py --help

\ can be removed as following,

30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py \ --no-color Volume1 example.com::slave-vol >> /var/log/glusterfs/schedule_georep.log 2> & 1

to

30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py --no-color Volume1 example.com::slave-vol >> /var/log/glusterfs/schedule_georep.log 2> & 1

Use cases,
1. This allows to run Geo-replication once a day or whenever scheduled instead of running all the time.
2. Geo-replication can be run during low IO(night)

Comment 8 Divya 2016-05-11 09:19:11 UTC
(In reply to Aravinda VK from comment #7)
> Thanks, Now I am able to access the page.
> 
> Comments:
> 
> We can add about `--help` option
> # python /usr/share/glusterfs/scripts/schedule_georep.py --help
> 
> \ can be removed as following,
> 
> 30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py \
> --no-color Volume1 example.com::slave-vol >>
> /var/log/glusterfs/schedule_georep.log 2> & 1
> 
> to
> 
> 30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py
> --no-color Volume1 example.com::slave-vol >>
> /var/log/glusterfs/schedule_georep.log 2> & 1
> 
> Use cases,
> 1. This allows to run Geo-replication once a day or whenever scheduled
> instead of running all the time.
> 2. Geo-replication can be run during low IO(night)

Hi Aravinda,

I have incorporated your comments.

Link to the latest doc: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#chap-Managing_Geo-replication-Schedule_Cron_Job

Please review and sign-off.

Comment 9 Aravinda VK 2016-05-13 08:08:15 UTC
Looks good to me.

Comment 10 Divya 2016-05-13 08:18:44 UTC
Based on Comment 9, moving the bug to ON_QA.

Comment 11 Rahul Hinduja 2016-06-06 20:00:17 UTC
Following small syntax errors are required:

1: 

Current: Cron assumes that the system is on continuously. If the system is not on when
Proposed: Cron assumes that the system is ON continuously. If the system is not ON when

2: Wrong syntax in Examples:

Current:
python /usr/share/glusterfs/scripts/schedule_georep.py Volume1 example.com::slave-vol

Should be: 
python /usr/share/glusterfs/scripts/schedule_georep.py Volume1 example.com slave-vol

3. Wrong syntax:

Current:
minute hour day month day-of-week directory_and_script-to-execute >> log_file_for_script_output

Should be:
minute hour day month day-of-week user scheduler_script MASTERVOL SLAVEHOST SLAVEVOL >> log_file_for_script_output

4. Wrong syntax in Examples:

Current:
30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py --no-color Volume1 example.com::slave-vol >> /var/log/glusterfs/schedule_georep.log 2>&1

Should be:
30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py --no-color Volume1 example.com slave-vol >> /var/log/glusterfs/schedule_georep.log 2>&1

Comment 15 Rahul Hinduja 2016-06-07 10:13:42 UTC
Verified the content of comment 14. Changes looks good to me. Moving this bug to verified.