diff options
Diffstat (limited to 'doc/radosgw/notifications.rst')
| -rw-r--r-- | doc/radosgw/notifications.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/radosgw/notifications.rst b/doc/radosgw/notifications.rst index 2bbd2c52edf..897c280facf 100644 --- a/doc/radosgw/notifications.rst +++ b/doc/radosgw/notifications.rst @@ -7,6 +7,10 @@ Bucket Notifications .. versionchanged:: Squid A new "v2" format for Topic and Notification metadata can be enabled with the :ref:`feature_notification_v2` zone feature. + Enabling this feature after an upgrade from an older version will trigger + migration of the existing Topic and Notification metadata. + In a greenfield deployment, the new format will be used. + The new format allows for the data to be synced between zones in the zonegroup. .. contents:: @@ -104,6 +108,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 ----------------------------------- @@ -172,6 +188,7 @@ updating, use the name of an existing topic and different endpoint values). [&Attributes.entry.15.key=Policy&Attributes.entry.15.value=<policy-JSON-string>] [&Attributes.entry.16.key=user-name&Attributes.entry.16.value=<user-name-string>] [&Attributes.entry.17.key=password&Attributes.entry.17.value=<password-string>] + [&Attributes.entry.18.key=kafka-brokers&Attributes.entry.18.value=<kafka-broker-list>] Request parameters: @@ -280,6 +297,8 @@ Request parameters: - "broker": Messages are considered "delivered" if acked by the broker. (This is the default.) + - kafka-brokers: A command-separated list of host:port of kafka brokers. These brokers (may contain a broker which is defined in kafka uri) will be added to kafka uri to support sending notifcations to a kafka cluster. + .. note:: - The key-value pair of a specific parameter need not reside in the same @@ -555,6 +574,7 @@ Valid AttributeName that can be passed: - mechanism: may be provided together with user/password (default: ``PLAIN``). - kafka-ack-level: No end2end acknowledgement is required. Messages may persist in the broker before being delivered to their final destinations. + - kafka-brokers: Set endpoint with broker(s) as a comma-separated list of host or host:port (default port 9092). Notifications ~~~~~~~~~~~~~ |