Merge pull request ceph#55535 from rhcs-dashboard/nvmeof-api-1.0.0

mgr/dashboard: update nvmeof protoc to 1.0.0

Reviewed-by: Avan Thakkar <[email protected]>
Reviewed-by: baum <NOT@FOUND>
Reviewed-by: Ernesto Puerta <[email protected]>

Author: nizamial09

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

@@ -27,8 +27,7 @@ def list(self, subsystem_nqn: str):
         @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):
+                   block_size: int = 512):
             """
             Create a new NVMeoF namespace
             :param rbd_pool: RBD pool name
@@ -37,24 +36,20 @@ def create(self, rbd_pool: str, rbd_image: str, subsystem_nqn: str,
             :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))
 
         @Endpoint('DELETE', path='{subsystem_nqn}')
-        def delete(self, subsystem_nqn: str, nsid: int):
+        @DeletePermission
+        def delete(self, subsystem_nqn: str):
             """
             Delete an existing NVMeoF namespace
             :param subsystem_nqn: NVMeoF subsystem NQN
-            :param nsid: NVMeoF namespace ID
             """
-            response = NVMeoFClient().delete_namespace(subsystem_nqn, nsid)
+            response = NVMeoFClient().delete_namespace(subsystem_nqn)
             return json.loads(MessageToJson(response))
 
     @APIRouter('/nvmeof/subsystem', Scope.NVME_OF)
@@ -64,39 +59,36 @@ class NvmeofSubsystem(RESTController):
         @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):
+        @ReadPermission
+        def list(self, subsystem_nqn: Optional[str] = None):
             response = MessageToJson(NVMeoFClient().list_subsystems(
-                subsystem_nqn=subsystem_nqn, serial_number=serial_number))
+                subsystem_nqn=subsystem_nqn))
 
             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):
+                   max_namespaces: Optional[int] = 256):
             """
             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)
+            response = NVMeoFClient().create_subsystem(subsystem_nqn, serial_number, max_namespaces)
             return json.loads(MessageToJson(response))
 
         @DeletePermission
         @Endpoint('DELETE', path='{subsystem_nqn}')
-        def delete(self, subsystem_nqn: str):
+        def delete(self, subsystem_nqn: str, force: Optional[bool] = False):
             """
             Delete an existing NVMeoF subsystem
             :param subsystem_nqn: NVMeoF subsystem NQN
+            :param force: Force delete
             """
-            response = NVMeoFClient().delete_subsystem(subsystem_nqn)
+            response = NVMeoFClient().delete_subsystem(subsystem_nqn, force)
             return json.loads(MessageToJson(response))
 
     @APIRouter('/nvmeof/hosts', Scope.NVME_OF)
@@ -144,39 +136,25 @@ def list(self, subsystem_nqn: str):
             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'):
+        def create(self, nqn: str, gateway: str, traddr: Optional[str] = None):
             """
             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)
+            response = NVMeoFClient().create_listener(nqn, gateway, traddr)
             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):
+        def delete(self, nqn: str, gateway: str, traddr: Optional[str] = None):
             """
             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)
+            response = NVMeoFClient().delete_listener(nqn, gateway, traddr)
             return json.loads(MessageToJson(response))
 
     @APIRouter('/nvmeof/gateway', Scope.NVME_OF)

src/pybind/mgr/dashboard/openapi.yaml

@@ -7806,34 +7806,19 @@ paths:
     post:
       description: "\n            Create a new NVMeoF listener\n            :param\
         \ nqn: NVMeoF subsystem NQN\n            :param gateway: NVMeoF gateway\n\
-        \            :param traddr: NVMeoF transport address\n            :param trtype:\
-        \ NVMeoF transport type\n            :param adrfam: NVMeoF address family\n\
-        \            :param trsvcid: NVMeoF transport service ID\n            :param\
-        \ auto_ha_state: NVMeoF auto HA state\n            "
+        \            :param traddr: NVMeoF transport address\n            "
       parameters: []
       requestBody:
         content:
           application/json:
             schema:
               properties:
-                adrfam:
-                  default: IPV4
-                  type: string
-                auto_ha_state:
-                  default: AUTO_HA_UNSET
-                  type: string
                 gateway:
                   type: string
                 nqn:
                   type: string
                 traddr:
                   type: string
-                trsvcid:
-                  default: 4420
-                  type: integer
-                trtype:
-                  default: TCP
-                  type: string
               required:
               - nqn
               - gateway
@@ -7866,10 +7851,7 @@ paths:
     delete:
       description: "\n            Delete an existing NVMeoF listener\n           \
         \ :param nqn: NVMeoF subsystem NQN\n            :param gateway: NVMeoF gateway\n\
-        \            :param traddr: NVMeoF transport address\n            :param transport_type:\
-        \ NVMeoF transport type\n            :param addr_family: NVMeoF address family\n\
-        \            :param transport_svc_id: NVMeoF transport service ID\n      \
-        \      "
+        \            :param traddr: NVMeoF transport address\n            "
       parameters:
       - in: path
         name: nqn
@@ -7886,21 +7868,6 @@ paths:
         name: traddr
         schema:
           type: string
-      - default: TCP
-        in: query
-        name: transport_type
-        schema:
-          type: string
-      - default: IPV4
-        in: query
-        name: addr_family
-        schema:
-          type: string
-      - default: 4420
-        in: query
-        name: transport_svc_id
-        schema:
-          type: integer
       responses:
         '202':
           content:
@@ -7932,18 +7899,13 @@ paths:
         \            :param subsystem_nqn: NVMeoF subsystem NQN\n            :param\
         \ create_image: Create RBD image\n            :param image_size: RBD image\
         \ size\n            :param block_size: NVMeoF namespace block size\n     \
-        \       :param nsid: NVMeoF namespace ID\n            :param uuid: NVMeoF\
-        \ namespace UUID\n            :param anagrpid: NVMeoF namespace ANA group\
-        \ ID\n            "
+        \       "
       parameters: []
       requestBody:
         content:
           application/json:
             schema:
               properties:
-                anagrpid:
-                  default: 1
-                  type: integer
                 block_size:
                   default: 512
                   type: integer
@@ -7953,17 +7915,12 @@ paths:
                 image_size:
                   default: 1024
                   type: integer
-                nsid:
-                  default: 1
-                  type: integer
                 rbd_image:
                   type: string
                 rbd_pool:
                   type: string
                 subsystem_nqn:
                   type: string
-                uuid:
-                  type: string
               required:
               - rbd_pool
               - rbd_image
@@ -7994,20 +7951,26 @@ paths:
       tags:
       - NVMe-oF
   /api/nvmeof/namespace/{subsystem_nqn}:
-    get:
-      description: "\n            List all NVMeoF namespaces\n            "
+    delete:
+      description: "\n            Delete an existing NVMeoF namespace\n          \
+        \  :param subsystem_nqn: NVMeoF subsystem NQN\n            "
       parameters:
       - in: path
         name: subsystem_nqn
         required: true
         schema:
           type: string
       responses:
-        '200':
+        '202':
           content:
             application/vnd.ceph.api.v1.0+json:
               type: object
-          description: OK
+          description: Operation is still executing. Please check the task queue.
+        '204':
+          content:
+            application/vnd.ceph.api.v1.0+json:
+              type: object
+          description: Resource deleted.
         '400':
           description: Operation exception. Please check the response body for details.
         '401':
@@ -8021,33 +7984,20 @@ paths:
       - jwt: []
       tags:
       - NVMe-oF
-  /api/nvmeof/namespace/{subsystem_nqn}/{nsid}:
-    delete:
-      description: "\n            Delete an existing NVMeoF namespace\n          \
-        \  :param subsystem_nqn: NVMeoF subsystem NQN\n            :param nsid: NVMeoF\
-        \ namespace ID\n            "
+    get:
+      description: "\n            List all NVMeoF namespaces\n            "
       parameters:
       - in: path
         name: subsystem_nqn
         required: true
         schema:
           type: string
-      - in: path
-        name: nsid
-        required: true
-        schema:
-          type: string
       responses:
-        '202':
-          content:
-            application/vnd.ceph.api.v1.0+json:
-              type: object
-          description: Operation is still executing. Please check the task queue.
-        '204':
+        '200':
           content:
             application/vnd.ceph.api.v1.0+json:
               type: object
-          description: Resource deleted.
+          description: OK
         '400':
           description: Operation exception. Please check the response body for details.
         '401':
@@ -8070,12 +8020,6 @@ paths:
         name: subsystem_nqn
         schema:
           type: string
-      - allowEmptyValue: true
-        description: NVMeoF subsystem serial number
-        in: query
-        name: serial_number
-        schema:
-          type: string
       responses:
         '200':
           content:
@@ -8100,21 +8044,13 @@ paths:
       description: "\n            Create a new NVMeoF subsystem\n\n            :param\
         \ subsystem_nqn: NVMeoF subsystem NQN\n            :param serial_number: NVMeoF\
         \ subsystem serial number\n            :param max_namespaces: NVMeoF subsystem\
-        \ maximum namespaces\n            :param ana_reporting: NVMeoF subsystem ANA\
-        \ reporting\n            :param enable_ha: NVMeoF subsystem enable HA\n  \
-        \          "
+        \ maximum namespaces\n            "
       parameters: []
       requestBody:
         content:
           application/json:
             schema:
               properties:
-                ana_reporting:
-                  default: false
-                  type: boolean
-                enable_ha:
-                  default: false
-                  type: boolean
                 max_namespaces:
                   default: 256
                   type: integer
@@ -8152,13 +8088,19 @@ paths:
   /api/nvmeof/subsystem/{subsystem_nqn}:
     delete:
       description: "\n            Delete an existing NVMeoF subsystem\n          \
-        \  :param subsystem_nqn: NVMeoF subsystem NQN\n            "
+        \  :param subsystem_nqn: NVMeoF subsystem NQN\n            :param force: Force\
+        \ delete\n            "
       parameters:
       - in: path
         name: subsystem_nqn
         required: true
         schema:
           type: string
+      - default: false
+        in: query
+        name: force
+        schema:
+          type: boolean
       responses:
         '202':
           content: