]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rgw/notification: add missing admin commands 60609/head
authorYuval Lifshitz <ylifshit@ibm.com>
Mon, 4 Nov 2024 14:24:22 +0000 (14:24 +0000)
committerZac Dover <zac.dover@proton.me>
Mon, 4 Nov 2024 15:26:11 +0000 (01:26 +1000)
also remove obsolete admin commands

Fixes: https://tracker.ceph.com/issues/68818
Signed-off-by: Yuval Lifshitz <ylifshit@ibm.com>
(cherry picked from commit ec272797c4caa5cf62319cdec104cf11575727b1)

doc/man/8/radosgw-admin.rst
doc/radosgw/notifications.rst

index 468ef1ebce6f1ccc32184919b64c58fe4773e693..2218ef798f00514647ee9e7e27ed7e018f998c83 100644 (file)
@@ -476,26 +476,19 @@ as follows:
   Cancel resharding a bucket
 
 :command:`topic list`
-  List bucket notifications/pubsub topics                                                   
+  List bucket notifications topics
 
 :command:`topic get`
-  Get a bucket notifications/pubsub topic                                                   
-  
-:command:`topic rm`
-  Remove a bucket notifications/pubsub topic                                                
+  Get a bucket notification topic 
 
-:command:`subscription get`
-  Get a pubsub subscription definition
-
-:command:`subscription rm`
-  Remove a pubsub subscription
+:command:`topic rm`
+  Remove a bucket notifications topic 
 
-:command:`subscription pull`
-  Show events in a pubsub subscription
-             
-:command:`subscription ack`
-  Acknowledge (remove) events in a pubsub subscription
+:command:`topic stats`
+  Get a bucket notifications persistent topic stats (i.e. reservations, entries & size)
 
+:command:`topic dump`
+  Dump (in JSON format) all pending bucket notifications of a persistent topic
 
 Options
 =======
index 259d64bf0989f814736bfd9e041277af81f392c7..6a9cf79cb8b2a5cce075ec9b93ee94d4cb1b0f21 100644 (file)
@@ -104,6 +104,18 @@ Remove a topic by running the following command:
 
    radosgw-admin topic rm --topic={topic-name} [--tenant={tenant}]
 
+Fetch persistent topic stats (i.e. reservations, entries and size) by running the following command: 
+
+.. prompt:: bash #
+
+   radosgw-admin topic stats --topic={topic-name} [--tenant={tenant}]
+
+Dump (in JSON format) all pending bucket notifications of a persistent topic by running the following command: 
+
+.. prompt:: bash #
+
+   radosgw-admin topic dump --topic={topic-name} [--tenant={tenant}] [--max-entries={max-entries}]
+
 
 Notification Performance Statistics
 -----------------------------------