فهرست منبع

Fixes to experimental transports in docs

Ask Solem 11 سال پیش
والد
کامیت
7983b0b928
4فایلهای تغییر یافته به همراه27 افزوده شده و 23 حذف شده
  1. 6 4
      docs/faq.rst
  2. 3 3
      docs/getting-started/first-steps-with-celery.rst
  3. 10 8
      docs/includes/installation.txt
  4. 8 8
      docs/userguide/workers.rst

+ 6 - 4
docs/faq.rst

@@ -197,15 +197,17 @@ Do I have to use AMQP/RabbitMQ?
 
 **Answer**: No.
 
-You can also use Redis, Beanstalk, CouchDB, MongoDB or an SQL database,
-see :ref:`brokers`.
+Although using RabbitMQ is recommended you can also use Redis.  There are also
+experimental transports available such as MongoDB, Beanstalk, CouchDB, or using
+SQL databases. See :ref:`brokers` for more information.
 
-These "virtual transports" may have limited broadcast and event functionality.
+The experimental transports may have reliability problems and
+limited broadcast and event functionality.
 For example remote control commands only works with AMQP and Redis.
 
 Redis or a database won't perform as well as
 an AMQP broker. If you have strict reliability requirements you are
-encouraged to use RabbitMQ or another AMQP broker. Redis/database also use
+encouraged to use RabbitMQ or another AMQP broker. Some transports also uses
 polling, so they are likely to consume more resources. However, if you for
 some reason are not able to use AMQP, feel free to use these alternatives.
 They will probably work fine for most use cases, and note that the above

+ 3 - 3
docs/getting-started/first-steps-with-celery.rst

@@ -144,8 +144,8 @@ this is needed so that names can be automatically generated, the second
 argument is the broker keyword argument which specifies the URL of the
 message broker you want to use, using RabbitMQ here, which is already the
 default option.  See :ref:`celerytut-broker` above for more choices,
-e.g. for Redis you can use ``redis://localhost``, or MongoDB:
-``mongodb://localhost``.
+e.g. for RabbitMQ you can use ``amqp://localhost``, or for Redis you can
+use ``redis://localhost``.
 
 You defined a single task, called ``add``, which returns the sum of two numbers.
 
@@ -373,7 +373,7 @@ instead, so that only 10 tasks of this type can be processed in a minute
         'tasks.add': {'rate_limit': '10/m'}
     }
 
-If you are using RabbitMQ, Redis or MongoDB as the
+If you are using RabbitMQ or Redis as the
 broker then you can also direct the workers to set a new rate limit
 for the task at runtime:
 

+ 10 - 8
docs/includes/installation.txt

@@ -68,10 +68,11 @@ Transports and Backends
     for using Redis as a message transport or as a result backend.
 
 :celery[mongodb]:
-    for using MongoDB as a message transport, or as a result backend.
+    for using MongoDB as a message transport (*experimental*),
+    or as a result backend (*supported*).
 
 :celery[sqs]:
-    for using Amazon SQS as a message transport.
+    for using Amazon SQS as a message transport (*experimental*).
 
 :celery[memcache]:
     for using memcached as a result backend.
@@ -80,28 +81,29 @@ Transports and Backends
     for using Apache Cassandra as a result backend.
 
 :celery[couchdb]:
-    for using CouchDB as a message transport.
+    for using CouchDB as a message transport (*experimental*).
 
 :celery[couchbase]:
     for using CouchBase as a result backend.
 
 :celery[beanstalk]:
-    for using Beanstalk as a message transport.
+    for using Beanstalk as a message transport (*experimental*).
 
 :celery[zookeeper]:
     for using Zookeeper as a message transport.
 
 :celery[zeromq]:
-    for using ZeroMQ as a message transport.
+    for using ZeroMQ as a message transport (*experimental*).
 
 :celery[sqlalchemy]:
-    for using SQLAlchemy as a message transport, or as a result backend.
+    for using SQLAlchemy as a message transport (*experimental*),
+    or as a result backend (*supported*).
 
 :celery[pyro]:
-    for using the Pyro4 message transport.
+    for using the Pyro4 message transport (*experimental*).
 
 :celery[slmq]:
-    for using the SoftLayer Message Queue transport.
+    for using the SoftLayer Message Queue transport (*experimental*).
 
 .. _celery-installing-from-source:
 

+ 8 - 8
docs/userguide/workers.rst

@@ -157,7 +157,7 @@ Remote control
     listed below.  See :ref:`monitoring-control` for more information.
 
 pool support: *prefork, eventlet, gevent*, blocking:*threads/solo* (see note)
-broker support: *amqp, redis, mongodb*
+broker support: *amqp, redis*
 
 Workers have the ability to be remote controlled using a high-priority
 broadcast message queue.  The commands can be directed to all, or a specific
@@ -228,7 +228,7 @@ using :meth:`~@control.broadcast`.
 Revoking tasks
 ==============
 pool support: all
-broker support: *amqp, redis, mongodb*
+broker support: *amqp, redis*
 
 All worker nodes keeps a memory of revoked task ids, either in-memory or
 persistent on disk (see :ref:`worker-persistent-revokes`).
@@ -324,8 +324,8 @@ name:
 
 
 Note that remote control commands must be working for revokes to work.
-Remote control commands are only supported by the RabbitMQ (amqp), Redis and MongDB
-transports at this point.
+Remote control commands are only supported by the RabbitMQ (amqp) and Redis
+at this point.
 
 .. _worker-time-limits:
 
@@ -379,7 +379,7 @@ Changing time limits at runtime
 -------------------------------
 .. versionadded:: 2.3
 
-broker support: *amqp, redis, mongodb*
+broker support: *amqp, redis*
 
 There is a remote control command that enables you to change both soft
 and hard time limits for a task — named ``time_limit``.
@@ -873,7 +873,7 @@ The output will include the following fields:
 
     * ``transport``
 
-        Name of transport used (e.g. ``amqp`` or ``mongodb``)
+        Name of transport used (e.g. ``amqp`` or ``redis``)
 
     * ``transport_options``
 
@@ -884,9 +884,9 @@ The output will include the following fields:
         Some transports expects the host name to be an URL, this applies to
         for example SQLAlchemy where the host name part is the connection URI:
 
-            sqla+sqlite:///
+            redis+socket:///tmp/redis.sock
 
-        In this example the uri prefix will be ``sqla``.
+        In this example the uri prefix will be ``redis``.
 
     * ``userid``