Browse Source

Redis docs now mention fanout_patterns caveat. Closes #1882

Ask Solem 11 years ago
parent
commit
7681e6d63c
1 changed files with 13 additions and 0 deletions
  1. 13 0
      docs/getting-started/brokers/redis.rst

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

@@ -80,6 +80,19 @@ Caveats
     This setting will be the default in the future, so better to migrate
     This setting will be the default in the future, so better to migrate
     sooner rather than later.
     sooner rather than later.
 
 
+- Workers will receive all task related events by default.
+
+    To avoid this you must set the ``fanout_patterns`` fanout option so that
+    the workers may only subscribe to worker related events::
+
+        BROKER_TRANSPORT_OPTIONS = {'fanout_patterns': True}
+
+    Note that this change is backward incompatible so all workers in the
+    cluster must have this option enabled, or else they will not be able to
+    communicate.
+
+    This option will be enabled by default in the future.
+
 - If a task is not acknowledged within the :ref:`redis-visibility_timeout`
 - If a task is not acknowledged within the :ref:`redis-visibility_timeout`
   the task will be redelivered to another worker and executed.
   the task will be redelivered to another worker and executed.