Bug 1495436

Summary: [geo-rep]: Scheduler help needs correction for description of --no-color
Product: [Community] GlusterFS Reporter: Kotresh HR <khiremat>
Component: geo-replicationAssignee: Kotresh HR <khiremat>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: low Docs Contact:
Priority: unspecified    
Version: mainlineCC: avishwan, bugs, csaba, rhinduja, rhs-bugs, storage-qa-internal
Target Milestone: ---   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: glusterfs-3.13.0 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 1475466
: 1496238 (view as bug list) Environment:
Last Closed: 2017-12-08 17:41:21 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: 1475466    
Bug Blocks: 1496238    

Description Kotresh HR 2017-09-26 03:53:48 UTC
Description of problem:
-----------------------

Currently the description of --no-color in the help of schedule_georep is "Use Color in CLI output". Whereas the default is with color, and if user provides this option, that means no color will be seen in the output and hence the description should be:

--no-color           Do not Use Color in CLI output

Output:
-------

[root@dhcp42-79 MASTER]#  python /usr/share/glusterfs/scripts/schedule_georep.py --h
usage: schedule_georep.py [-h] [--interval INTERVAL] [--timeout TIMEOUT]
                          [--no-color]
                          mastervol SLAVE slavevol

Schedule Geo-replication
------------------------
A tool to run Geo-replication when required. This can be used to
schedule the Geo-replication to run once in a day using

   # Run daily at 08:30pm
   30 20 * * * root python /usr/share/glusterfs/scripts/schedule_georep.py \
      --no-color gv1 fvm1 gv2 >> /var/log/glusterfs/schedule_georep.log 2>&1

This tool does the following,

1. Stop Geo-replication if Started
2. Start Geo-replication
3. Set Checkpoint
4. Check the Status and see Checkpoint is Complete.(LOOP)
5. If checkpoint complete, Stop Geo-replication

Usage:

    python /usr/share/glusterfs/scripts/schedule_georep.py <MASTERVOL> \
         <SLAVEHOST> <SLAVEVOL>

For example,

    python /usr/share/glusterfs/scripts/schedule_georep.py gv1 fvm1 gv2

positional arguments:
  mastervol            Master Volume Name
  SLAVE                SLAVEHOST or root@SLAVEHOST or user@SLAVEHOST
  slavevol             Slave Volume Name

optional arguments:
  -h, --help           show this help message and exit
  --interval INTERVAL  Interval in Seconds. Wait time before each status check
  --timeout TIMEOUT    Timeout in minutes. Script will stop Geo-replication if
                       Checkpoint is not complete in the specified timeout
                       time
  --no-color           Use Color in CLI output
[root@dhcp42-79 MASTER]# 


Version-Release number of selected component (if applicable):
=============================================================

mainline

Comment 1 Worker Ant 2017-09-26 03:56:09 UTC
REVIEW: https://review.gluster.org/18388 (geo-rep/scheduler: Fix '--no-color' help msg) posted (#1) for review on master by Kotresh HR (khiremat)

Comment 2 Worker Ant 2017-09-26 09:28:49 UTC
COMMIT: https://review.gluster.org/18388 committed in master by Aravinda VK (avishwan) 
------
commit 8855ebcfecde2a21e0a9ba725e9738708e03904a
Author: Kotresh HR <khiremat>
Date:   Mon Sep 25 23:34:55 2017 -0400

    geo-rep/scheduler: Fix '--no-color' help msg
    
    Change-Id: I0f51558083e0b11a6563b8a2ef62ec07fe2a9ca9
    BUG: 1495436
    Signed-off-by: Kotresh HR <khiremat>

Comment 3 Shyamsundar 2017-12-08 17:41:21 UTC
This bug is getting closed because a release has been made available that should address the reported issue. In case the problem is still not fixed with glusterfs-3.13.0, please open a new bug report.

glusterfs-3.13.0 has been announced on the Gluster mailinglists [1], packages for several distributions should become available in the near future. Keep an eye on the Gluster Users mailinglist [2] and the update infrastructure for your distribution.

[1] http://lists.gluster.org/pipermail/announce/2017-December/000087.html
[2] https://www.gluster.org/pipermail/gluster-users/