浏览代码

Adds broker comparison table. Closes #963

Ask Solem 12 年之前
父节点
当前提交
e801a30f67

+ 2 - 1
docs/configuration.rst

@@ -1,4 +1,4 @@
-.' _configuration:
+.. _configuration:
 
 
 ============================
 ============================
  Configuration and defaults
  Configuration and defaults
@@ -227,6 +227,7 @@ Can be one of the following:
 .. _`MongoDB`: http://mongodb.org
 .. _`MongoDB`: http://mongodb.org
 .. _`Redis`: http://code.google.com/p/redis/
 .. _`Redis`: http://code.google.com/p/redis/
 .. _`Cassandra`: http://cassandra.apache.org/
 .. _`Cassandra`: http://cassandra.apache.org/
+.. _`IronCache`: http://www.iron.io/cache
 
 
 .. setting:: CELERY_RESULT_SERIALIZER
 .. setting:: CELERY_RESULT_SERIALIZER
 
 

+ 49 - 0
docs/getting-started/brokers/index.rst

@@ -9,6 +9,11 @@
 
 
 Celery supports several message transport alternatives.
 Celery supports several message transport alternatives.
 
 
+.. _broker_toc:
+
+Broker Instructions
+===================
+
 .. toctree::
 .. toctree::
     :maxdepth: 1
     :maxdepth: 1
 
 
@@ -21,3 +26,47 @@ Celery supports several message transport alternatives.
     couchdb
     couchdb
     beanstalk
     beanstalk
     ironmq
     ironmq
+
+.. _broker-overview:
+
+Broker Overview
+===============
+
+This is comparison table of the different transports supports,
+more information can be found in the documentation for each
+individual transport (see :ref:`broker_toc`).
+
++---------------+--------------+----------------+--------------------+
+| **Name**      | **Status**   | **Monitoring** | **Remote Control** |
++---------------+--------------+----------------+--------------------+
+| *RabbitMQ*    | Stable       | Yes            | Yes                |
++---------------+--------------+----------------+--------------------+
+| *Redis*       | Stable       | Yes            | Yes                |
++---------------+--------------+----------------+--------------------+
+| *Mongo DB*    | Experimental | Yes            | Yes                |
++---------------+--------------+----------------+--------------------+
+| *Beanstalk*   | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *Amazon SQS*  | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *Couch DB*    | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *Zookeeper*   | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *Django DB*   | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *SQLAlchemy*  | Experimental | No             | No                 |
++---------------+--------------+----------------+--------------------+
+| *Iron MQ*     | 3rd party    | No             | No                 |
++---------------+--------------+----------------+--------------------+
+
+Experimental brokers may be functional but they do not have
+dedicated maintainers.
+
+Missing monitor support means that the transport does not
+implement events, and as such Flower, `celery events`, `celerymon`
+and other event-based monitoring tools will not work.
+
+Remote control means the ability to inspect and manage workers
+at runtime using the `celery inspect` and `celery control` commands
+(and other tools using the remote control API).

+ 3 - 3
docs/getting-started/brokers/ironmq.rst

@@ -46,14 +46,14 @@ And in this case the broker url may only be::
     ironmq://
     ironmq://
 
 
 Clouds
 Clouds
------
+------
 
 
 The default cloud/region is ``AWS us-east-1``. You can choose the IronMQ Rackspace cloud by changing the URL to::
 The default cloud/region is ``AWS us-east-1``. You can choose the IronMQ Rackspace cloud by changing the URL to::
 
 
     ironmq://project_id:token@mq-rackspace-dfw.iron.io
     ironmq://project_id:token@mq-rackspace-dfw.iron.io
 
 
 Results
 Results
-======
+=======
 
 
 You can store results in IronCache with the same Iron.io credentials, just set the results URL with the same syntax
 You can store results in IronCache with the same Iron.io credentials, just set the results URL with the same syntax
 as the broker URL, but changing the start to ``ironcache``::
 as the broker URL, but changing the start to ``ironcache``::
@@ -65,6 +65,6 @@ This will default to a cache named "Celery", if you want to change that::
     ironcache:://project_id:token@/awesomecache
     ironcache:://project_id:token@/awesomecache
 
 
 More Information
 More Information
-===============
+================
 
 
 You can find more information in the [iron_celery README](http://github.com/iron-io/iron_celery).
 You can find more information in the [iron_celery README](http://github.com/iron-io/iron_celery).

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

@@ -97,16 +97,11 @@ robust system in production.
 Other brokers
 Other brokers
 -------------
 -------------
 
 
-In addition to the above, there are other transport implementations
-to choose from, including
+In addition to the above, there are other experimental transport implementations
+to choose from, including :ref:`Amazon SQS <broker-sqs>`, :ref:`broker-mongodb`
+and :ref:`IronMQ <broker-ironmq>`.
 
 
-* :ref:`Amazon SQS <broker-sqs>`
-* :ref:`broker-mongodb`
-* :ref:`IronMQ <broker-ironmq>`
-
-See also `Transport Comparison`_.
-
-.. _`Transport Comparison`: http://kombu.readthedocs.org/en/latest/introduction.html#transport-comparison
+See :ref:`broker-overview`.
 
 
 .. _celerytut-installation:
 .. _celerytut-installation: