aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Zinoviev <me@ch1p.io>2021-03-02 03:15:09 +0300
committerEvgeny Zinoviev <me@ch1p.io>2021-03-02 03:15:09 +0300
commit0f55c987a6b964aeeb1c8d02810747740ced4b19 (patch)
treefbc121e4739e289f1d5ab057d26d7915db3e9ccc
parente44b8be9ea214d4a989d6a48cd22e74ec4a5e5d7 (diff)
readme: document jobd and jobd-master requests
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index b8688cd..8df8c56 100644
--- a/README.md
+++ b/README.md
@@ -43,11 +43,33 @@ CREATE TABLE `jobs` (
For optimization purposes, you can turn fields `target` and `slot` into `ENUM`s.
+## jobd requests
+
+* **`poll(targets=[])`** — get new tasks for specified `targets` from database.
+ If `targets` is empty or not specified, get tasks for all serving targets.
+
+* **`status`** — returns status of internal queues and memory usage.
+
+* **`run-manual(id)`** — enqueue and run job with specified `id` and `status` set to
+ `manual` and return results.
+
+
+## jobd-master requests
+
+* **`register-worker(targets)`** — used by a jobd instance to register itself
+ with master. You don't need it.
+
+* **`poke(targets)`** — send `poll` requests to all registered workers that serve
+ specified `targets`.
+
+* **`status`** — returns list of registered workers and memory usage.
+
+
## TODO
**jobd**:
- `pause(targets)` / `continue(targets)`
-- `runManual` with multiple jobs
+- `run-manual` with multiple jobs
**jobd-master**:
- `status(workers=true)`