From 7467a1b49f6d8b8fd279002bb975dac006465784 Mon Sep 17 00:00:00 2001 From: Nick Gauthier Date: Wed, 10 Feb 2010 11:41:39 -0500 Subject: [PATCH] Documentation for remote and global tasks --- README.rdoc | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rdoc b/README.rdoc index 98de4b6..d9266ff 100644 --- a/README.rdoc +++ b/README.rdoc @@ -32,6 +32,26 @@ Run: Hydra defaults to Single Core mode, so you may want to configure it to use two (or more) of your cores if you have a multi-processing machine. +== Running Remote Tasks + +You can run tasks across all of your remote workers easily with Hydra. In your rake file, add: + + Hydra::RemoteTask.new('db:reset') + +Then you can run: + + rake hydra:remote:db:reset + +== Running Global Tasks + +A Global task is a task run locally *and* remotely. It's used in the same way as RemoteTask: + + Hydra::GlobalTask.new('db:reset') + +But it is invoked in a higher namespace: + + rake hydra:db:reset + == Configuration Place the config file in the main project directory as