Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cenkalti committed Jul 25, 2013
1 parent 5b93a6b commit 191ec9b
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ Commands
Kuyruk has only one command which consists of several sub-commands.
``kuyruk`` command usually takes a single ``--config`` argument
which is the ``.py`` file containing configuration options.

If no ``--config`` option is given it will be looked from environmental
variable ``KUYRUK_CONFIG``. Set it with::

$ export KUYRUK_CONFIG=/home/cenk/app1/config/kuyruk.py

... or add it to your ``.bashrc`` file.

Each option in config can be overriden from command line. Example::

$ kuyruk --config config.py --max-run-time 60 SUBCOMMAND
Expand All @@ -19,9 +27,9 @@ Worker
``worker`` sub-command starts a worker that consumes messages from a queue and
run tasks. Example::

$ kuyruk --config config.py worker --queue heavy_jobs
$ kuyruk --config config.py worker --queue mp4_conversion

If called with no parameters it will use the default configuration options and
If called with no parameters it will use default configuration options and
queue. Example::

$ kuyruk worker
Expand All @@ -43,8 +51,8 @@ connection so there is nothing shared between workers. Usage::

$ kuyruk --config config.py master

Also workers poll the master see if it is alive and if master dies, each
worker initiates a graceful shutdown.
Also workers poll the master see if it is alive.
If the master dies, workers are shut down gracefully.


Requeue
Expand Down

0 comments on commit 191ec9b

Please sign in to comment.