Merge pull request ceph#65079 from rhcs-dashboard/img-summary-mirroring

mgr/dashboard: expose image summary API

Author: nizamial09

src/pybind/mgr/dashboard/controllers/_base_controller.py

@@ -1,3 +1,4 @@
+import datetime
 import inspect
 import json
 import logging
@@ -279,9 +280,15 @@ def inner(*args, **kwargs):
                                                              if version else 'application/xml')
                 return ret.encode('utf8')
             if json_response:
+                # convert datetime obj so json can serialize properly
+                def json_default(obj):
+                    if isinstance(obj, datetime.datetime):
+                        return obj.isoformat().replace("+00:00", "Z")
+                    return str(obj)
+
                 cherrypy.response.headers['Content-Type'] = (version.to_mime_type(subtype='json')
                                                              if version else 'application/json')
-                ret = json.dumps(ret).encode('utf8')
+                ret = json.dumps(ret, default=json_default).encode('utf8')
             return ret
         return inner
 

src/pybind/mgr/dashboard/controllers/rbd_mirroring.py

@@ -37,6 +37,26 @@ class MirrorHealth(IntEnum):
     MIRROR_HEALTH_DISABLED = 4
     MIRROR_HEALTH_INFO = 5
 
+
+MIRROR_IMAGE_STATUS_MAP = {
+    rbd.MIRROR_IMAGE_STATUS_STATE_UNKNOWN: "Unknown",
+    rbd.MIRROR_IMAGE_STATUS_STATE_ERROR: "Error",
+    rbd.MIRROR_IMAGE_STATUS_STATE_SYNCING: "Syncing",
+    rbd.MIRROR_IMAGE_STATUS_STATE_STARTING_REPLAY: "Starting Replay",
+    rbd.MIRROR_IMAGE_STATUS_STATE_REPLAYING: "Replaying",
+    rbd.MIRROR_IMAGE_STATUS_STATE_STOPPING_REPLAY: "Stopping Replay",
+    rbd.MIRROR_IMAGE_STATUS_STATE_STOPPED: "Stopped",
+}
+
+
+def get_mirror_status_label(code: int) -> str:
+    default_code = rbd.MIRROR_IMAGE_STATUS_STATE_UNKNOWN
+    return MIRROR_IMAGE_STATUS_MAP.get(
+        code,
+        MIRROR_IMAGE_STATUS_MAP[default_code]
+    )
+
+
 # pylint: disable=not-callable
 
 
@@ -220,6 +240,31 @@ def _get_pool_stats(pool_names):
     return pool_stats
 
 
+def _get_mirroring_status(pool_name, image_name):
+    ioctx = mgr.rados.open_ioctx(pool_name)
+    mode = rbd.RBD().mirror_mode_get(ioctx)
+    status = rbd.Image(ioctx, image_name).mirror_image_get_status()
+    for remote in status.get("remote_statuses", []):
+        remote["state"] = get_mirror_status_label(remote["state"])
+        desc = remote.get("description")
+
+        if not desc.startswith("replaying, "):
+            continue
+
+        try:
+            metrics = json.loads(desc.split(", ", 1)[1])
+            remote["description"] = metrics
+        except (IndexError, json.JSONDecodeError):
+            continue
+
+        if mode == rbd.RBD_MIRROR_MODE_POOL:
+            primary_tid = metrics["primary_position"]["entry_tid"]
+            non_primary_tid = metrics["non_primary_position"]["entry_tid"]
+            percent_done = (non_primary_tid / primary_tid) * 100 if primary_tid else 0
+            remote["syncing_percent"] = round(percent_done, 2)
+    return status
+
+
 @ViewCache()
 def get_daemons_and_pools():  # pylint: disable=R0915
     daemons = get_daemons()
@@ -387,8 +432,10 @@ def _get_content_data():  # pylint: disable=R0914
             }
 
             if mirror_image['health'] == 'ok':
+                status = _get_mirroring_status(pool_name, mirror_image['name'])
                 image.update({
-                    'description': mirror_image['description']
+                    'description': mirror_image['description'],
+                    'remote_status': status.get("remote_statuses", [])
                 })
                 image_ready.append(image)
             elif mirror_image['health'] == 'syncing':
@@ -487,6 +534,17 @@ def __call__(self):
                 'content_data': content_data}
 
 
+@APIRouter('/block/mirroring/{pool_name}/{image_name}/summary', Scope.RBD_MIRRORING)
+@APIDoc("RBD Mirroring Summary Management API", "RbdMirroringSummary")
+class RbdImageMirroringSummary(BaseController):
+
+    @Endpoint()
+    @handle_rbd_mirror_error()
+    @ReadPermission
+    def __call__(self, pool_name, image_name):
+        return _get_mirroring_status(pool_name, image_name)
+
+
 @APIRouter('/block/mirroring/pool', Scope.RBD_MIRRORING)
 @APIDoc("RBD Mirroring Pool Mode Management API", "RbdMirroringPoolMode")
 class RbdMirroringPoolMode(RESTController):

src/pybind/mgr/dashboard/openapi.yaml

@@ -1558,6 +1558,38 @@ paths:
       summary: Display Rbd Mirroring Summary
       tags:
       - RbdMirroringSummary
+  /api/block/mirroring/{pool_name}/{image_name}/summary:
+    get:
+      parameters:
+      - in: path
+        name: pool_name
+        required: true
+        schema:
+          type: string
+      - in: path
+        name: image_name
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/vnd.ceph.api.v1.0+json:
+              type: object
+          description: OK
+        '400':
+          description: Operation exception. Please check the response body for details.
+        '401':
+          description: Unauthenticated access. Please login first.
+        '403':
+          description: Unauthorized access. Please check your permissions.
+        '500':
+          description: Unexpected error. Please check the response body for the stack
+            trace.
+      security:
+      - jwt: []
+      tags:
+      - RbdMirroringSummary
   /api/block/pool/{pool_name}/namespace:
     get:
       parameters: