From: Andreas Unterkircher <unki@netshadow.net>
Date: Fri, 24 Apr 2020 05:09:11 +0000 (+0200)
Subject: rgw: add a doc hint that the topic-name is used as AMQP routing-key
X-Git-Tag: v17.0.0~1850^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=41f26bffe2a8047a491c32b19b76d6c61f7a9d7f;p=ceph.git

rgw: add a doc hint that the topic-name is used as AMQP routing-key

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
---

diff --git a/doc/radosgw/notifications.rst b/doc/radosgw/notifications.rst
index 264c4b3a127b9..96e1f374d6814 100644
--- a/doc/radosgw/notifications.rst
+++ b/doc/radosgw/notifications.rst
@@ -122,13 +122,15 @@ Request parameters:
  - user/password may only be provided over HTTPS. Topic creation request will be rejected if not
  - port defaults to: 5672
  - vhost defaults to: "/"
- - amqp-exchange: the exchanges must exist and be able to route messages based on topics (mandatory parameter for AMQP0.9.1)
+ - amqp-exchange: the exchanges must exist and be able to route messages based on topics (mandatory parameter for AMQP0.9.1). Different topics pointing to the same endpoint must use the same exchange
  - amqp-ack-level: no end2end acking is required, as messages may persist in the broker before delivered into their final destination. Three ack methods exist:
 
   - "none": message is considered "delivered" if sent to broker
   - "broker": message is considered "delivered" if acked by broker (default)
   - "routable": message is considered "delivered" if broker can route to a consumer
 
+.. tip:: The topic-name (see :ref:`radosgw-create-a-topic`) is used for the AMQP topic ("routing key" for a topic exchange)
+
 - Kafka endpoint 
 
  - URI: ``kafka://[<user>:<password>@]<fqdn>[:<port]``
diff --git a/doc/radosgw/pubsub-module.rst b/doc/radosgw/pubsub-module.rst
index 52a542baca6e4..2fbcfe367c0bd 100644
--- a/doc/radosgw/pubsub-module.rst
+++ b/doc/radosgw/pubsub-module.rst
@@ -189,6 +189,8 @@ PubSub REST API
 Topics
 ~~~~~~
  
+.. _radosgw-create-a-topic:
+
 Create a Topic
 ``````````````
 
@@ -224,13 +226,15 @@ The endpoint URI may include parameters depending with the type of endpoint:
  - user/password may only be provided over HTTPS. Topic creation request will be rejected if not
  - port defaults to: 5672
  - vhost defaults to: "/"
- - amqp-exchange: the exchanges must exist and be able to route messages based on topics (mandatory parameter for AMQP0.9.1)
+ - amqp-exchange: the exchanges must exist and be able to route messages based on topics (mandatory parameter for AMQP0.9.1). Different topics pointing to the same endpoint must use the same exchange
  - amqp-ack-level: no end2end acking is required, as messages may persist in the broker before delivered into their final destination. Three ack methods exist:
 
   - "none": message is considered "delivered" if sent to broker
   - "broker": message is considered "delivered" if acked by broker (default)
   - "routable": message is considered "delivered" if broker can route to a consumer
 
+.. tip:: The topic-name (see :ref:`radosgw-create-a-topic`) is used for the AMQP topic ("routing key" for a topic exchange)
+
 - Kafka endpoint 
 
  - URI: ``kafka://[<user>:<password>@]<fqdn>[:<port]``