Skip to content

Commit

Permalink
Merge pull request ceph#60608 from yuvalif/wip-yuval-68818
Browse files Browse the repository at this point in the history
doc/rgw/notification: add missing admin commands

Reviewed-by: Anthony D'Atri <[email protected]>
  • Loading branch information
zdover23 authored Nov 4, 2024
2 parents c8e3946 + ec27279 commit a8e43a9
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 15 deletions.
23 changes: 8 additions & 15 deletions doc/man/8/radosgw-admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======
Expand Down
12 changes: 12 additions & 0 deletions doc/radosgw/notifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------
Expand Down

0 comments on commit a8e43a9

Please sign in to comment.