From 2a607ffe894f5a2586529bf8fa12a33ef992278f Mon Sep 17 00:00:00 2001 From: igomon Date: Tue, 16 Apr 2024 15:35:21 -0400 Subject: [PATCH] rgw/s3-notifications: updated notifications doc to reflect the usage of the new topic attributes Signed-off-by: Igor Gomon (cherry picked from commit 1cc1f8a2725ddce21986b1c64fa813b434ff9bb1) --- doc/radosgw/notifications.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/radosgw/notifications.rst b/doc/radosgw/notifications.rst index 6a9cf79cb8b..f352b57afb8 100644 --- a/doc/radosgw/notifications.rst +++ b/doc/radosgw/notifications.rst @@ -182,6 +182,8 @@ updating, use the name of an existing topic and different endpoint values). [&Attributes.entry.13.key=max_retries&Attributes.entry.13.value=] [&Attributes.entry.14.key=retry_sleep_duration&Attributes.entry.14.value=] [&Attributes.entry.15.key=Policy&Attributes.entry.15.value=] + [&Attributes.entry.16.key=user-name&Attributes.entry.16.value=] + [&Attributes.entry.17.key=password&Attributes.entry.17.value=] Request parameters: @@ -270,6 +272,10 @@ Request parameters: - user/password: This should be provided over HTTPS. If not, the config parameter `rgw_allow_notification_secrets_in_cleartext` must be `true` in order to create topics. - user/password: This should be provided together with ``use-ssl``. If not, the broker credentials will be sent over insecure transport. - mechanism: may be provided together with user/password (default: ``PLAIN``). The supported SASL mechanisms are: + - ``user-name``: User name to use when connecting to the Kafka broker. If both this parameter and URI user are provided then this parameter overrides the URI user. + The same security considerations are in place for this parameter as are for user/password. + - ``password``: Password to use when connecting to the Kafka broker. If both this parameter and URI password are provided then this parameter overrides the URI password. + The same security considerations are in place for this parameter as are for user/password. - PLAIN - SCRAM-SHA-256 -- 2.39.5