From 0f55c987a6b964aeeb1c8d02810747740ced4b19 Mon Sep 17 00:00:00 2001 From: Evgeny Zinoviev Date: Tue, 2 Mar 2021 03:15:09 +0300 Subject: readme: document jobd and jobd-master requests --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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)` -- cgit v1.2.3