Change in vdsm[master]: gluster: geo replication status and status detail

Hello Bala.FA,

I'd like you to do a code review.  Please visit

    http://gerrit.ovirt.org/18414

to review the following change.

Change subject: gluster: geo replication status and status detail
......................................................................

gluster: geo replication status and status detail

this has two verbs, status: provides geo-replication status of all running
sessions or all sessions associated with a perticular source volume or
session between a source and remote volume. status detail: provides detailed
status of geo-repliction session between source and remote volume

Change-Id: I4f37f35a5480fbe049a67758e122d4a0c2eba513
Signed-off-by: ndarshan <dnarayan(a)redhat.com&gt;
---
M client/vdsClientGluster.py
M vdsm/gluster/api.py
M vdsm/gluster/cli.py
M vdsm/gluster/exception.py
M vdsm/gluster/vdsmapi-gluster-schema.json
5 files changed, 223 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.ovirt.org:29418/vdsm refs/changes/14/18414/1

diff --git a/client/vdsClientGluster.py b/client/vdsClientGluster.py
index 90af83e..76a5ba8 100644
--- a/client/vdsClientGluster.py
+++ b/client/vdsClientGluster.py
@@ -424,6 +424,35 @@
         pp.pprint(status)
         return status['status']['code'],
status['status']['message']
 
+    def do_glusterVolumeGeoRepStatus(self, args):
+        params = self._eqSplit(args)
+        try:
+            volName = params.get('volName', '')
+            remoteHost = params.get('remoteHost', '')
+            remoteVolName = params.get('remoteVolName', '')
+        except:
+            raise ValueError
+        status = self.s.glusterVolumeGeoRepStatus(volName, remoteHost,
+                                                  remoteVolName)
+        pp.pprint(status)
+        return status['status']['code'],
status['status']['message']
+
+    def do_glusterVolumeGeoRepStatusDetail(self, args):
+        params = self._eqSplit(args)
+        try:
+            volName = params.get('volName', '')
+            remoteHost = params.get('remoteHost', '')
+            remoteVolName = params.get('remoteVolName', '')
+        except:
+            raise ValueError
+        if not (volName and remoteHost and remoteVolName):
+            raise ValueError
+        status = self.s.glusterVolumeGeoRepStatusDetail(volName,
+                                                        remoteHost,
+                                                        remoteVolName)
+        pp.pprint(status)
+        return status['status']['code'],
status['status']['message']
+
 
 def getGlusterCmdDict(serv):
     return \
@@ -705,4 +734,24 @@
               'not set'
               '(swift, glusterd, smb, memcached)'
               )),
+         'glusterVolumeGeoRepStatus': (
+             serv.do_glusterVolumeGeoRepStatus,
+             ('volName=<master_volume_name> '
+              'remoteHost=<slave_host_name> '
+              'remoteVolName=<slave_volume_name> '
+              '<master_volume_name>existing volume name in the master
node\n\t'
+              '<slave_host_name>is remote slave host name or ip\n\t'
+              '<slave_volume_name>existing volume name in the slave node',
+              'Returns ths status of geo-replication'
+              )),
+         'glusterVolumeGeoRepStatusDetail': (
+             serv.do_glusterVolumeGeoRepStatusDetail,
+             ('volName=<master_volume_name> '
+              'remoteHost=<slave_host_name> '
+              'remoteVolName=<slave_volume_name> '
+              '<master_volume_name>existing volume name in the master
node\n\t'
+              '<slave_host_name>is remote slave host name or ip\n\t'
+              '<slave_volume_name>existing volume name in the slave node',
+              'Returns the Detailed status of geo-replication'
+              ))
          }
diff --git a/vdsm/gluster/api.py b/vdsm/gluster/api.py
index 4bd8308..d24e700 100644
--- a/vdsm/gluster/api.py
+++ b/vdsm/gluster/api.py
@@ -287,6 +287,22 @@
         status = self.svdsmProxy.glusterServicesGet(serviceNames)
         return {'services': status}
 
+    @exportAsVerb
+    def volumeGeoRepStatus(self, volName=None, remoteHost=None,
+                           remoteVolName=None, options=None):
+        status = self.svdsmProxy.glusterVolumeGeoRepStatus(volName,
+                                                           remoteHost,
+                                                           remoteVolName)
+        return {'geo-rep': status}
+
+    @exportAsVerb
+    def volumeGeoRepStatusDetail(self, volName, remoteHost,
+                                 remoteVolName, options=None):
+        status = self.svdsmProxy.glusterVolumeGeoRepStatusDetail(volName,
+                                                                 remoteHost,
+                                                                 remoteVolName)
+        return {'geo-rep': status}
+
 
 def getGlusterMethods(gluster):
     l = []
diff --git a/vdsm/gluster/cli.py b/vdsm/gluster/cli.py
index bac6d1c..1cf0e12 100644
--- a/vdsm/gluster/cli.py
+++ b/vdsm/gluster/cli.py
@@ -897,3 +897,59 @@
         return _parseVolumeProfileInfo(xmltree, nfs)
     except _etreeExceptions:
         raise ge.GlusterXmlErrorException(err=[etree.tostring(xmltree)])
+
+
+def _parseGeoRepStatusDetail(tree):
+    status = {'node': tree.find('geoRep/node').text,
+              'health': tree.find('geoRep/health').text,
+              'uptime': tree.find('geoRep/uptime').text,
+              'filesSyncd': tree.find('geoRep/filesSyncd').text,
+              'filesPending': tree.find('geoRep/filesPending').text,
+              'bytesPending': tree.find('geoRep/bytesPending').text,
+              'deletesPending': tree.find('geoRep/deletesPending').text}
+    return status
+
+
+def _parseGeoRepStatus(tree):
+    pairs = []
+    for el in tree.findall('geoRep/pair'):
+        value = {}
+        value['node'] = el.find('node').text
+        value['master'] = el.find('master').text
+        value['slave'] = el.find('slave').text
+        value['health'] = el.find('health').text
+        value['uptime'] = el.find('uptime').text
+        pairs.append(value)
+    return pairs
+
+
+@makePublic
+def volumeGeoRepStatus(volName=None, remoteHost=None, remoteVolName=None,
+                       ):
+    command = _getGlusterVolCmd() + ["geo-replication", volName,
+                                     "%s::%s" % (remoteHost, remoteVolName),
+                                     "status"]
+    try:
+        xmltree = _execGlusterXml(command)
+    except ge.GlusterCmdFailedException as e:
+        raise ge.GlusterGeoRepStatusFailedException(rc=e.rc, err=e.err)
+    try:
+        return _parseGeoRepStatus(xmltree)
+    except _etreeExceptions:
+        raise ge.GlusterXmlErrorException(err=[etree.tostring(xmltree)])
+
+
+@makePublic
+def volumeGeoRepStatusDetail(volName, remoteHost, remoteVolName,
+                             ):
+    command = _getGlusterVolCmd() + ["geo-replication", volName,
+                                     "%s::%s" % (remoteHost, remoteVolName),
+                                     "status", "detail"]
+    try:
+        xmltree = _execGlusterXml(command)
+    except ge.GlusterCmdFailedException as e:
+        raise ge.GlusterGeoRepStatusDetailFailedException(rc=e.rc, err=e.err)
+    try:
+        return _parseGeoRepStatusDetail(xmltree)
+    except _etreeExceptions:
+        raise ge.GlusterXmlErrorException(err=[etree.tostring(xmltree)])
diff --git a/vdsm/gluster/exception.py b/vdsm/gluster/exception.py
index c569a9e..d95b168 100644
--- a/vdsm/gluster/exception.py
+++ b/vdsm/gluster/exception.py
@@ -484,3 +484,19 @@
         prefix = "%s: " % (action)
         self.message = prefix + "Service action is not supported"
         self.err = [self.message]
+
+
+#geo-replication
+class GlusterGeoRepException(GlusterException):
+    code = 4560
+    message = "Gluster Geo-Replication Exception"
+
+
+class GlusterGeoRepStatusFailedException(GlusterGeoRepException):
+    code = 4565
+    message = "Geo Rep status failed"
+
+
+class GlusterGeoRepStatusDetailFailedException(GlusterGeoRepException):
+    code = 4566
+    message = "Geo Rep status detail failed"
diff --git a/vdsm/gluster/vdsmapi-gluster-schema.json
b/vdsm/gluster/vdsmapi-gluster-schema.json
index 7a4c034..557c750 100644
--- a/vdsm/gluster/vdsmapi-gluster-schema.json
+++ b/vdsm/gluster/vdsmapi-gluster-schema.json
@@ -372,3 +372,89 @@
 {'command': {'class': 'GlusterService', 'name':
'action'},
  'data': {'serviceName': 'str', 'action':
'GlusterServiceAction'},
  'returns': 'GlusterServicesStatusInfo'}
+
+##
+# @GlusterGeoRepStatus:
+#
+# Gluster geo-replication status information.
+#
+# @node:   The node where geo-replication is started
+#
+# @master:   The source for geo-replication
+#
+# @slave:   The destination of geo-replication
+#
+# @health:   The status of the geo-replication session
+#
+# @uptime:   The time since the geo-replication started
+#
+# Since: 4.10.3
+##
+{'type': 'GlusterGeoRepStatus',
+ 'data': {'node': 'str', 'master': 'str',
'slave': 'str', 'health': 'str', 'uptime':
'int'}}
+
+
+##
+# @GlusterVolume.geoRepStatus:
+#
+# Gets the status of geo-Replication session
+#
+# @masterVolName:    Is an existing volume name in the master node
+#
+# @slaveHost:    Is remote slave host name or ip
+#
+# @slaveVolName:   Is an available existing volume name in the slave node
+#
+# Returns:
+# status information for geo-replication
+#
+# Since: 4.10.3
+##
+{'command': {'class': 'GlusterVolume', 'name':
'geoRepStatus'},
+ 'data': {'masterVolName': 'str', 'slaveHost':
'str', 'slaveVolName': 'str'},
+ 'returns': 'GlusterGeoRepStatus'}
+
+##
+# @GlusterGeoRepStatusDetail:
+#
+# Gluster geo-replication detailed status information.
+#
+# @node:   The node where geo-replication is started
+#
+# @health:   The status of the geo-replication session
+#
+# @uptime:   The time since the geo-replication started
+#
+# @filesSyncd:   The number of files that are synced
+#
+# @filesPending:   The number of files that are pending to be synced
+#
+# @bytesPending:   The number of bytes that are pending to be synced
+#
+# @deletesPending:   The number of deletes that are pending
+#
+# Since: 4.10.3
+##
+{'type': 'GlusterGeoRepStatusDetail',
+ 'data': {'node': 'str', 'health': 'str',
'uptime': 'int', 'filesSyncd': 'int',
'filesPending': 'int',
+          'bytesPending': 'int','deletesPending':
'int'}}
+
+##
+# @GlusterVolume.geoRepStatusDetail:
+#
+# Gets the detailed status of geo-Replication session
+#
+# @masterVolName:    Is an existing volume name in the master node
+#
+# @slaveHost:    Is remote slave host name or ip
+#
+# @slaveVolName:   Is an available existing volume name in the slave node
+#
+# Returns:
+# detailed status information of geo-replication session
+#
+# Since: 4.10.3
+##
+{'command': {'class': 'GlusterVolume', 'name':
'geoRepStatusDetail'},
+ 'data': {'masterVolName': 'str', 'slaveHost':
'str', 'slaveVolName': 'str'},
+ 'returns': 'GlusterGeoRepStatusDetail'}


-- 
To view, visit http://gerrit.ovirt.org/18414
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I4f37f35a5480fbe049a67758e122d4a0c2eba513
Gerrit-PatchSet: 1
Gerrit-Project: vdsm
Gerrit-Branch: master
Gerrit-Owner: ndarshan <dnarayan(a)redhat.com&gt;
Gerrit-Reviewer: Bala.FA <barumuga(a)redhat.com&gt;