From ec272797c4caa5cf62319cdec104cf11575727b1 Mon Sep 17 00:00:00 2001 From: Yuval Lifshitz Date: Mon, 4 Nov 2024 14:24:22 +0000 Subject: [PATCH] doc/rgw/notification: add missing admin commands also remove obsolete admin commands Fixes: https://tracker.ceph.com/issues/68818 Signed-off-by: Yuval Lifshitz --- doc/man/8/radosgw-admin.rst | 23 ++++++++--------------- doc/radosgw/notifications.rst | 12 ++++++++++++ 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst index 7dfa59a61b1..c7750c348ad 100644 --- a/doc/man/8/radosgw-admin.rst +++ b/doc/man/8/radosgw-admin.rst @@ -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 - + Get a bucket notification topic + :command:`topic rm` - Remove a bucket notifications/pubsub topic + Remove a bucket notifications topic -:command:`subscription get` - Get a pubsub subscription definition - -:command:`subscription rm` - Remove a pubsub subscription - -: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 ======= diff --git a/doc/radosgw/notifications.rst b/doc/radosgw/notifications.rst index 2bbd2c52edf..f352b57afb8 100644 --- a/doc/radosgw/notifications.rst +++ b/doc/radosgw/notifications.rst @@ -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 -----------------------------------