mgr/dashboard: adapt to new nvmeof APIs

Fixes: https://tracker.ceph.com/issues/64201
Signed-off-by: Nizamudeen A <[email protected]>

Author: nizamial09

ceph.spec.in

@@ -625,6 +625,8 @@ Requires:       ceph-mgr = %{_epoch_prefix}%{version}-%{release}
 Requires:       ceph-grafana-dashboards = %{_epoch_prefix}%{version}-%{release}
 Requires:       ceph-prometheus-alerts = %{_epoch_prefix}%{version}-%{release}
 Requires:       python%{python3_pkgversion}-setuptools
+Requires:       python%{python3_pkgversion}-grpcio
+Requires:       python%{python3_pkgversion}-grpcio-tools
 %if 0%{?fedora} || 0%{?rhel} || 0%{?openEuler}
 Requires:       python%{python3_pkgversion}-cherrypy
 Requires:       python%{python3_pkgversion}-routes

debian/control

@@ -96,6 +96,7 @@ Build-Depends: automake,
                tox <pkg.ceph.check>,
                python3-coverage <pkg.ceph.check>,
                python3-dateutil <pkg.ceph.check>,
+               python3-grpcio <pkg.ceph.check>,
                python3-openssl <pkg.ceph.check>,
                python3-prettytable <pkg.ceph.check>,
                python3-requests <pkg.ceph.check>,

src/pybind/mgr/cephadm/services/nvmeof.py

@@ -121,7 +121,7 @@ def post_remove(self, daemon: DaemonDescription, is_failed_deploy: bool) -> None
             'name': daemon.hostname,
         })
         if not ret:
-            logger.info(f'{daemon.hostname} removed from iscsi gateways dashboard config')
+            logger.info(f'{daemon.hostname} removed from nvmeof gateways dashboard config')
 
         # and any certificates being used for mTLS
 

src/pybind/mgr/dashboard/constraints.txt

@@ -4,5 +4,3 @@ bcrypt~=3.1
 python3-saml~=1.4
 requests~=2.26
 Routes~=2.4
-grpcio~=1.48
-grpcio-tools~=1.48

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

@@ -1,108 +1,192 @@
-# # import grpc
+# -*- coding: utf-8 -*-
+import json
+from typing import Optional
 
-# from .proto import gateway_pb2 as pb2
-# from .proto import gateway_pb2_grpc as pb2_grpc
+from ..security import Scope
+from . import APIDoc, APIRouter, CreatePermission, DeletePermission, Endpoint, \
+    EndpointDoc, ReadPermission, RESTController
 
+try:
+    from google.protobuf.json_format import MessageToJson
 
-# class NVMeoFClient(object):
-#     def __init__(self):
-#         self.host = '192.168.100.102'
+    from ..services.nvmeof_client import NVMeoFClient
+except ImportError:
+    MessageToJson = None
+else:
+    @APIRouter('/nvmeof/namespace', Scope.NVME_OF)
+    @APIDoc('NVMe-oF Namespace Management API', 'NVMe-oF')
+    class NvmeofNamespace(RESTController):
+        @ReadPermission
+        def list(self, subsystem_nqn: str):
+            """
+            List all NVMeoF namespaces
+            """
+            response = MessageToJson(NVMeoFClient().list_namespaces(subsystem_nqn))
+            return json.loads(response)
 
-# from ..cephnvmeof.control.cli import GatewayClient
+        @CreatePermission
+        def create(self, rbd_pool: str, rbd_image: str, subsystem_nqn: str,
+                   create_image: Optional[bool] = True, image_size: Optional[int] = 1024,
+                   block_size: int = 512, nsid: Optional[int] = 1,
+                   uuid: Optional[str] = None, anagrpid: Optional[int] = 1):
+            """
+            Create a new NVMeoF namespace
+            :param rbd_pool: RBD pool name
+            :param rbd_image: RBD image name
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            :param create_image: Create RBD image
+            :param image_size: RBD image size
+            :param block_size: NVMeoF namespace block size
+            :param nsid: NVMeoF namespace ID
+            :param uuid: NVMeoF namespace UUID
+            :param anagrpid: NVMeoF namespace ANA group ID
+            """
+            response = NVMeoFClient().create_namespace(rbd_pool, rbd_image,
+                                                       subsystem_nqn, block_size,
+                                                       nsid, uuid, anagrpid,
+                                                       create_image, image_size)
+            return json.loads(MessageToJson(response))
 
-from typing import Optional
-from ..security import Scope
-from ..services.nvmeof_client import NVMeoFClient
-# from ..services.proto import gateway_pb2 as pb2
-from . import APIDoc, APIRouter, RESTController, Endpoint, ReadPermission, CreatePermission, \
-    DeletePermission, allow_empty_body, UpdatePermission
-    
-
-@APIRouter('/nvmeof', Scope.NVME_OF)
-@APIDoc('NVMe-oF Management API', 'NVMe-oF')
-class Nvmeof(RESTController):
-    @ReadPermission
-    def list(self):
-        """List all NVMeoF gateways"""
-        return NVMeoFClient().get_subsystems()
-
-
-@APIRouter('/nvmeof/bdev', Scope.NVME_OF)
-@APIDoc('NVMe-oF Block Device Management API', 'NVMe-oF')
-class NvmeofBdev(RESTController):
-    @CreatePermission
-    def create(self, name: str, rbd_pool: str, rbd_image: str, block_size: int, uuid: Optional[str] = None):
-        """Create a new NVMeoF block device"""
-        return NVMeoFClient().create_bdev(name, rbd_pool, rbd_image, block_size, uuid)
-    
-    @DeletePermission
-    @allow_empty_body
-    def delete(self, name: str, force: bool):
-        """Delete an existing NVMeoF block device"""
-        return NVMeoFClient().delete_bdev(name, force)
-    
-    @Endpoint('PUT')
-    @UpdatePermission
-    @allow_empty_body
-    def resize(self, name: str, size: int):
-        """Resize an existing NVMeoF block device"""
-        return NVMeoFClient().resize_bdev(name, size)
-
-
-@APIRouter('/nvmeof/namespace', Scope.NVME_OF)
-@APIDoc('NVMe-oF Namespace Management API', 'NVMe-oF')
-class NvmeofNamespace(RESTController):
-    @CreatePermission
-    def create(self, subsystem_nqn: str, bdev_name: str, nsid: int, anagrpid: Optional[str] = None):
-        """Create a new NVMeoF namespace"""
-        return NVMeoFClient().create_namespace(subsystem_nqn, bdev_name, nsid, anagrpid)
-    
-    @Endpoint('DELETE', path='{subsystem_nqn}')
-    def delete(self, subsystem_nqn: str, nsid: int):
-        """Delete an existing NVMeoF namespace"""
-        return NVMeoFClient().delete_namespace(subsystem_nqn, nsid)
-    
-@APIRouter('/nvmeof/subsystem', Scope.NVME_OF)
-@APIDoc('NVMe-oF Subsystem Management API', 'NVMe-oF')
-class NvmeofSubsystem(RESTController):
-    @CreatePermission
-    def create(self, subsystem_nqn: str, serial_number: str, max_namespaces: int,
-                         ana_reporting: bool, enable_ha: bool) :
-        """Create a new NVMeoF subsystem"""
-        return NVMeoFClient().create_subsystem(subsystem_nqn, serial_number, max_namespaces,
-                                               ana_reporting, enable_ha)
-    
-    @Endpoint('DELETE', path='{subsystem_nqn}')
-    def delete(self, subsystem_nqn: str):
-        """Delete an existing NVMeoF subsystem"""
-        return NVMeoFClient().delete_subsystem(subsystem_nqn)
-
-
-@APIRouter('/nvmeof/hosts', Scope.NVME_OF)
-@APIDoc('NVMe-oF Host Management API', 'NVMe-oF')
-class NvmeofHost(RESTController):
-    @CreatePermission
-    def create(self, subsystem_nqn: str, host_nqn: str):
-        """Create a new NVMeoF host"""
-        return NVMeoFClient().add_host(subsystem_nqn, host_nqn)
-    
-    @Endpoint('DELETE')
-    def delete(self, subsystem_nqn: str, host_nqn: str):
-        """Delete an existing NVMeoF host"""
-        return NVMeoFClient().remove_host(subsystem_nqn, host_nqn)
-
-
-@APIRouter('/nvmeof/listener', Scope.NVME_OF)
-@APIDoc('NVMe-oF Listener Management API', 'NVMe-oF')
-class NvmeofListener(RESTController):
-    @CreatePermission
-    def create(self, nqn: str, gateway: str, trtype: str, adrfam: str,
-               traddr: str, trsvcid: str):
-        """Create a new NVMeoF listener"""
-        return NVMeoFClient().create_listener(nqn, gateway, trtype, adrfam, traddr, trsvcid)
-    
-    @Endpoint('DELETE')
-    def delete(self, nqn: str, gateway: str, trtype, adrfam,
-               traddr: str, trsvcid: str):
-        """Delete an existing NVMeoF listener"""
-        return NVMeoFClient().delete_listener(nqn, gateway, trtype, adrfam, traddr, trsvcid)
+        @Endpoint('DELETE', path='{subsystem_nqn}')
+        def delete(self, subsystem_nqn: str, nsid: int):
+            """
+            Delete an existing NVMeoF namespace
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            :param nsid: NVMeoF namespace ID
+            """
+            response = NVMeoFClient().delete_namespace(subsystem_nqn, nsid)
+            return json.loads(MessageToJson(response))
+
+    @APIRouter('/nvmeof/subsystem', Scope.NVME_OF)
+    @APIDoc('NVMe-oF Subsystem Management API', 'NVMe-oF')
+    class NvmeofSubsystem(RESTController):
+        @ReadPermission
+        @EndpointDoc("List all NVMeoF gateways",
+                     parameters={
+                         'subsystem_nqn': (str, 'NVMeoF subsystem NQN'),
+                         'serial_number': (str, 'NVMeoF subsystem serial number')
+                     })
+        def list(self, subsystem_nqn: Optional[str] = None, serial_number: Optional[str] = None):
+            response = MessageToJson(NVMeoFClient().list_subsystems(
+                subsystem_nqn=subsystem_nqn, serial_number=serial_number))
+
+            return json.loads(response)
+
+        @CreatePermission
+        def create(self, subsystem_nqn: str, serial_number: Optional[str] = None,
+                   max_namespaces: Optional[int] = 256, ana_reporting: Optional[bool] = False,
+                   enable_ha: Optional[bool] = False):
+            """
+            Create a new NVMeoF subsystem
+
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            :param serial_number: NVMeoF subsystem serial number
+            :param max_namespaces: NVMeoF subsystem maximum namespaces
+            :param ana_reporting: NVMeoF subsystem ANA reporting
+            :param enable_ha: NVMeoF subsystem enable HA
+            """
+            response = NVMeoFClient().create_subsystem(subsystem_nqn, serial_number, max_namespaces,
+                                                       ana_reporting, enable_ha)
+            return json.loads(MessageToJson(response))
+
+        @DeletePermission
+        @Endpoint('DELETE', path='{subsystem_nqn}')
+        def delete(self, subsystem_nqn: str):
+            """
+            Delete an existing NVMeoF subsystem
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            """
+            response = NVMeoFClient().delete_subsystem(subsystem_nqn)
+            return json.loads(MessageToJson(response))
+
+    @APIRouter('/nvmeof/hosts', Scope.NVME_OF)
+    @APIDoc('NVMe-oF Host Management API', 'NVMe-oF')
+    class NvmeofHost(RESTController):
+        @ReadPermission
+        def list(self, subsystem_nqn: str):
+            """
+            List all NVMeoF hosts
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            """
+            response = MessageToJson(NVMeoFClient().list_hosts(subsystem_nqn))
+            return json.loads(response)
+
+        @CreatePermission
+        def create(self, subsystem_nqn: str, host_nqn: str):
+            """
+            Create a new NVMeoF host
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            :param host_nqn: NVMeoF host NQN
+            """
+            response = NVMeoFClient().add_host(subsystem_nqn, host_nqn)
+            return json.loads(MessageToJson(response))
+
+        @DeletePermission
+        def delete(self, subsystem_nqn: str, host_nqn: str):
+            """
+            Delete an existing NVMeoF host
+            :param subsystem_nqn: NVMeoF subsystem NQN
+            :param host_nqn: NVMeoF host NQN
+            """
+            response = NVMeoFClient().remove_host(subsystem_nqn, host_nqn)
+            return json.loads(MessageToJson(response))
+
+    @APIRouter('/nvmeof/listener', Scope.NVME_OF)
+    @APIDoc('NVMe-oF Listener Management API', 'NVMe-oF')
+    class NvmeofListener(RESTController):
+        @ReadPermission
+        def list(self, subsystem_nqn: str):
+            """
+            List all NVMeoF listeners
+            :param nqn: NVMeoF subsystem NQN
+            """
+            response = MessageToJson(NVMeoFClient().list_listeners(subsystem_nqn))
+            return json.loads(response)
+
+        @CreatePermission
+        def create(self, nqn: str, gateway: str, traddr: Optional[str] = None,
+                   trtype: Optional[str] = 'TCP', adrfam: Optional[str] = 'IPV4',
+                   trsvcid: Optional[int] = 4420,
+                   auto_ha_state: Optional[str] = 'AUTO_HA_UNSET'):
+            """
+            Create a new NVMeoF listener
+            :param nqn: NVMeoF subsystem NQN
+            :param gateway: NVMeoF gateway
+            :param traddr: NVMeoF transport address
+            :param trtype: NVMeoF transport type
+            :param adrfam: NVMeoF address family
+            :param trsvcid: NVMeoF transport service ID
+            :param auto_ha_state: NVMeoF auto HA state
+            """
+            response = NVMeoFClient().create_listener(nqn, gateway, traddr,
+                                                      trtype, adrfam, trsvcid, auto_ha_state)
+            return json.loads(MessageToJson(response))
+
+        @DeletePermission
+        def delete(self, nqn: str, gateway: str, traddr: Optional[str] = None,
+                   transport_type: Optional[str] = 'TCP', addr_family: Optional[str] = 'IPV4',
+                   transport_svc_id: Optional[int] = 4420):
+            """
+            Delete an existing NVMeoF listener
+            :param nqn: NVMeoF subsystem NQN
+            :param gateway: NVMeoF gateway
+            :param traddr: NVMeoF transport address
+            :param transport_type: NVMeoF transport type
+            :param addr_family: NVMeoF address family
+            :param transport_svc_id: NVMeoF transport service ID
+            """
+            response = NVMeoFClient().delete_listener(nqn, gateway, traddr, transport_type,
+                                                      addr_family, transport_svc_id)
+            return json.loads(MessageToJson(response))
+
+    @APIRouter('/nvmeof/gateway', Scope.NVME_OF)
+    @APIDoc('NVMe-oF Gateway Management API', 'NVMe-oF')
+    class NvmeofGateway(RESTController):
+        @ReadPermission
+        @Endpoint()
+        def info(self):
+            """
+            Get NVMeoF gateway information
+            """
+            response = MessageToJson(NVMeoFClient().gateway_info())
+            return json.loads(response)

src/pybind/mgr/dashboard/module.py

@@ -29,6 +29,7 @@
 from . import mgr
 from .controllers import Router, json_error_page
 from .grafana import push_local_dashboards
+from .services import nvmeof_cli  # noqa # pylint: disable=unused-import
 from .services.auth import AuthManager, AuthManagerTool, JwtManager
 from .services.exception import dashboard_exception_handler
 from .services.rgw_client import configure_rgw_credentials
@@ -37,9 +38,6 @@
 from .tools import NotificationQueue, RequestLoggingTool, TaskManager, \
     prepare_url_prefix, str_to_bool
 
-# pylint: disable=unused-import
-from .services import nvmeof_cli
-
 try:
     import cherrypy
     from cherrypy._cptools import HandlerWrapperTool