Browse Source

Redis: Users should enable the prefix_fanout transport option (Issue #1490).

Ask Solem 11 years ago
parent
commit
41c009f1dc
2 changed files with 27 additions and 0 deletions
  1. 13 0
      docs/getting-started/brokers/redis.rst
  2. 14 0
      docs/whatsnew-3.1.rst

+ 13 - 0
docs/getting-started/brokers/redis.rst

@@ -67,6 +67,19 @@ For a complete list of options supported by the Redis result backend, see
 Caveats
 =======
 
+- Broadcast messages will be seen by all virtual hosts by default.
+
+    You have to set a transport option to prefix the messages so that
+    they will only be received by the active virtual host::
+
+        BROKER_TRANSPORT_OPTIONS = {'fanout_prefix': True}
+
+    Note that you will not be able to communicate with workers running older
+    versions or workers that does not have this setting enabled.
+
+    This setting will be the default in the future, so better to migrate
+    sooner rather than later.
+
 - If a task is not acknowledged within the :ref:`redis-visibility_timeout`
   the task will be redelivered to another worker and executed.
 

+ 14 - 0
docs/whatsnew-3.1.rst

@@ -160,6 +160,20 @@ In Other News
     no longer happens as a side-effect of importing the :mod:`djcelery`
     module.
 
+- Redis: Option to separate broadcast messages by virtual host (Issue #1490).
+
+    Broadcast messages are seen by all virtual hosts when using the Redis
+    transport.  You can fix this by enabling a prefix to all channels
+    so that the messages are separated by virtual host::
+
+        BROKER_TRANSPORT_OPTIONS = {'fanout_prefix': True}
+
+    Note that you will not be able to communicate with workers running older
+    versions or workers that does not have this setting enabled.
+
+    This setting will be the default in the future, so better to migrate
+    sooner rather than later.
+
 - ``Signature.freeze()`` can now be used to "finalize" subtasks
 
     Regular subtask: