From 8f6c672734a27a05f013281cb54ae7965231c6a6 Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Fri, 3 Jul 2015 21:59:24 +0200 Subject: [PATCH] Getting docs ready fro 0.2.0 --- docs/cluster.rst | 8 ++++++++ docs/index.rst | 2 ++ docs/install.rst | 2 ++ docs/tasks.rst | 2 ++ 4 files changed, 14 insertions(+) diff --git a/docs/cluster.rst b/docs/cluster.rst index 81b07c0..cba3e90 100644 --- a/docs/cluster.rst +++ b/docs/cluster.rst @@ -40,6 +40,14 @@ Stopping the cluster with ctrl-c or either the `SIGTERM` and `SIGKILL` signals, 16:44:14 [Q] INFO Process-1:9 stopped monitoring results 16:44:15 [Q] INFO Q Cluster-31781 has stopped. +Multiple Clusters +----------------- +You can have as many clusters, on as many machines as you want, working on the same queue as long as: + +- They connect to the same Redis server. +- They use the same cluster name. See :ref:`configuration` +- They share the same :const:`SECRET_KEY` + Using a Procfile ---------------- If you host on `Heroku `__ or you are using `Honcho `__ you can start the cluster from a :file:`Procfile` like this:: diff --git a/docs/index.rst b/docs/index.rst index 2c74631..9b29a55 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,8 @@ Features - Django Admin integration - PaaS compatible with multiple instances - Multi cluster monitor +- Redis +- Python 2 and 3 Contents: diff --git a/docs/install.rst b/docs/install.rst index ab5d468..fe27f1e 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -20,6 +20,8 @@ Installation - Make sure you have a `Redis `__ server running somewhere +.. _configuration: + Configuration ------------- diff --git a/docs/tasks.rst b/docs/tasks.rst index 79e61dd..08725c3 100644 --- a/docs/tasks.rst +++ b/docs/tasks.rst @@ -55,6 +55,8 @@ Use :py:func:`async` from your code to quickly offload tasks to the py:module:` :returns: The task :rtype: Task + .. versionchanged:: 0.2.0 + Renamed from get_task .. py:class:: Task