Merge pull request ceph#61075 from rhcs-dashboard/topicmanagment

mgr/dashboard: Add RGW topics endpoint creation for create ,delete and list in dashboard

Author: nizamial09

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

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 # pylint: disable=C0302
+
 import json
 import logging
 import re
@@ -16,7 +17,8 @@
 from ..services.auth import AuthManager, JwtManager
 from ..services.ceph_service import CephService
 from ..services.rgw_client import _SYNC_GROUP_ID, NoRgwDaemonsException, \
-    RgwClient, RgwMultisite, RgwMultisiteAutomation, RgwRateLimit
+    RgwClient, RgwMultisite, RgwMultisiteAutomation, RgwRateLimit, \
+    RgwTopicmanagement
 from ..services.rgw_iam import RgwAccounts
 from ..services.service import RgwServiceManager, wait_for_daemon_to_start
 from ..tools import json_str_to_object, str_to_bool
@@ -1405,3 +1407,112 @@ def get_user_list(self, zoneName=None, realmName=None):
         multisite_instance = RgwMultisite()
         result = multisite_instance.get_user_list(zoneName, realmName)
         return result
+
+
+@APIRouter('/rgw/topic', Scope.RGW)
+@APIDoc("RGW Topic Management API", "RGW Topic Management")
+class RgwTopic(RESTController):
+
+    @EndpointDoc(
+        "Create a new RGW Topic",
+        parameters={
+            "name": (str, "Name of the topic"),
+            "push_endpoint": (str, "Push Endpoint"),
+            "opaque_data": (str, " opaque data"),
+            "persistent": (bool, "persistent"),
+            "time_to_live": (str, "Time to live"),
+            "max_retries": (str, "max retries"),
+            "retry_sleep_duration": (str, "retry sleep duration"),
+            "policy": (str, "policy"),
+            "verify_ssl": (bool, 'verify ssl'),
+            "cloud_events": (str, 'cloud events'),
+            "user": (str, 'user'),
+            "password": (str, 'password'),
+            "vhost": (str, 'vhost'),
+            "ca_location": (str, 'ca location'),
+            "amqp_exchange": (str, 'amqp exchange'),
+            "amqp_ack_level": (str, 'amqp ack level'),
+            "use_ssl": (bool, 'use ssl'),
+            "kafka_ack_level": (str, 'kafka ack level'),
+            "kafka_brokers": (str, 'kafka brokers'),
+            "mechanism": (str, 'mechanism'),
+        },
+    )
+    def create(
+        self,
+        name: str,
+        daemon_name=None,
+        owner=None,
+        push_endpoint: Optional[str] = None,
+        opaque_data: Optional[str] = None,
+        persistent: Optional[bool] = False,
+        time_to_live: Optional[str] = None,
+        max_retries: Optional[str] = None,
+        retry_sleep_duration: Optional[str] = None,
+        policy: Optional[str] = None,
+        verify_ssl: Optional[bool] = False,
+        cloud_events: Optional[bool] = False,
+        ca_location: Optional[str] = None,
+        amqp_exchange: Optional[str] = None,
+        amqp_ack_level: Optional[str] = None,
+        use_ssl: Optional[bool] = False,
+        kafka_ack_level: Optional[str] = None,
+        kafka_brokers: Optional[str] = None,
+        mechanism: Optional[str] = None
+    ):
+        rgw_topic_instance = RgwClient.instance(owner, daemon_name=daemon_name)
+        return rgw_topic_instance.create_topic(
+            name=name,
+            push_endpoint=push_endpoint,
+            opaque_data=opaque_data,
+            persistent=persistent,
+            time_to_live=time_to_live,
+            max_retries=max_retries,
+            retry_sleep_duration=retry_sleep_duration,
+            policy=policy,
+            verify_ssl=verify_ssl,
+            cloud_events=cloud_events,
+            ca_location=ca_location,
+            amqp_exchange=amqp_exchange,
+            amqp_ack_level=amqp_ack_level,
+            use_ssl=use_ssl,
+            kafka_ack_level=kafka_ack_level,
+            kafka_brokers=kafka_brokers,
+            mechanism=mechanism
+        )
+
+    @EndpointDoc(
+        "Get RGW Topic List",
+        parameters={
+            "uid": (str, "Name of the user"),
+            "tenant": (str, "Name of the tenant"),
+        },
+    )
+    def list(self, uid: Optional[str] = None, tenant: Optional[str] = None):
+        rgw_topic_instance = RgwTopicmanagement()
+        result = rgw_topic_instance.list_topics(uid, tenant)
+        return result
+
+    @EndpointDoc(
+        "Get RGW Topic",
+        parameters={
+            "name": (str, "Name of the user"),
+            "tenant": (str, "Name of the tenant"),
+        },
+    )
+    def get(self, name: str, tenant: Optional[str] = None):
+        rgw_topic_instance = RgwTopicmanagement()
+        result = rgw_topic_instance.get_topic(name, tenant)
+        return result
+
+    @EndpointDoc(
+        "Delete RGW Topic",
+        parameters={
+            "name": (str, "Name of the user"),
+            "tenant": (str, "Name of the tenant"),
+        },
+    )
+    def delete(self, name: str, tenant: Optional[str] = None):
+        rgw_topic_instance = RgwTopicmanagement()
+        result = rgw_topic_instance.delete_topic(name=name, tenant=tenant)
+        return result

src/pybind/mgr/dashboard/openapi.yaml

@@ -12944,6 +12944,209 @@ paths:
       - jwt: []
       tags:
       - RgwSite
+  /api/rgw/topic:
+    get:
+      parameters:
+      - allowEmptyValue: true
+        description: Name of the user
+        in: query
+        name: uid
+        schema:
+          type: string
+      - allowEmptyValue: true
+        description: Name of the tenant
+        in: query
+        name: tenant
+        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: []
+      summary: Get RGW Topic List
+      tags:
+      - RGW Topic Management
+    post:
+      parameters: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                amqp_ack_level:
+                  description: amqp ack level
+                  type: string
+                amqp_exchange:
+                  description: amqp exchange
+                  type: string
+                ca_location:
+                  description: ca location
+                  type: string
+                cloud_events:
+                  default: false
+                  description: cloud events
+                  type: string
+                daemon_name:
+                  type: string
+                kafka_ack_level:
+                  description: kafka ack level
+                  type: string
+                kafka_brokers:
+                  description: kafka brokers
+                  type: string
+                max_retries:
+                  description: max retries
+                  type: string
+                mechanism:
+                  description: mechanism
+                  type: string
+                name:
+                  description: Name of the topic
+                  type: string
+                opaque_data:
+                  description: ' opaque data'
+                  type: string
+                owner:
+                  type: string
+                persistent:
+                  default: false
+                  description: persistent
+                  type: boolean
+                policy:
+                  description: policy
+                  type: string
+                push_endpoint:
+                  description: Push Endpoint
+                  type: string
+                retry_sleep_duration:
+                  description: retry sleep duration
+                  type: string
+                time_to_live:
+                  description: Time to live
+                  type: string
+                use_ssl:
+                  default: false
+                  description: use ssl
+                  type: boolean
+                verify_ssl:
+                  default: false
+                  description: verify ssl
+                  type: boolean
+              required:
+              - name
+              type: object
+      responses:
+        '201':
+          content:
+            application/vnd.ceph.api.v1.0+json:
+              type: object
+          description: Resource created.
+        '202':
+          content:
+            application/vnd.ceph.api.v1.0+json:
+              type: object
+          description: Operation is still executing. Please check the task queue.
+        '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: []
+      summary: Create a new RGW Topic
+      tags:
+      - RGW Topic Management
+  /api/rgw/topic/{name}:
+    delete:
+      parameters:
+      - description: Name of the user
+        in: path
+        name: name
+        required: true
+        schema:
+          type: string
+      - allowEmptyValue: true
+        description: Name of the tenant
+        in: query
+        name: tenant
+        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':
+          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':
+          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: []
+      summary: Delete RGW Topic
+      tags:
+      - RGW Topic Management
+    get:
+      parameters:
+      - description: Name of the user
+        in: path
+        name: name
+        required: true
+        schema:
+          type: string
+      - allowEmptyValue: true
+        description: Name of the tenant
+        in: query
+        name: tenant
+        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: []
+      summary: Get RGW Topic
+      tags:
+      - RGW Topic Management
   /api/rgw/user:
     get:
       parameters:
@@ -17840,6 +18043,8 @@ tags:
   name: PrometheusNotifications
 - description: List of RGW roles
   name: RGW
+- description: RGW Topic Management API
+  name: RGW Topic Management
 - description: RBD Management API
   name: Rbd
 - description: RBD Mirroring Management API