]> mj.ucw.cz Git - bex.git/blob - NOTES
Bits of documentation
[bex.git] / NOTES
1 ### Structure of queue directories ###
2
3 <queue>/hosts/<hostname>/       Jobs queued for the given host
4                                 (they are executed in the lexicographic order of <job-id>s)
5         /<job-id>.job           Symlink to <queue>/jobs/<job-id>.job
6         /<job-id>.stat          (Optional) status of the job
7         /<job-id>.tmp           Used temporarily by brun to store the script actually
8                                 sent to the host (can be inspected if something goes wrong)
9
10 <queue>/jobs/<job-id>.job       All jobs issued on this queue, including those which
11                                 are no longer queued for any machine
12
13 <queue>/log                     Log of actions on this queue. Lines look this way:
14                                 YYYY-MM-DD HH:MM:SS <host> <job-id> <status> [<msg>]
15                                 <status> and <msg> correspond to "Status" and "Message"
16                                 in status files.
17
18 <queue>/status-fifo             FIFO used for reporting status of subprocesses by `bprun'
19
20 ### Job files ###
21
22 Mail-like structure. First come the headers (<keyword>:<spaces><value>), keywords are
23 case-sensitive, no multi-line fields allowed, then an empty line and then the body
24 (i.e., commands to be executed on the remote host).
25
26 Known header fields:
27
28 ID: <job-id>                    Identifier of the job, unique in the scope of a queue
29 Subject: <subject>              Subject to be displayed to the user
30
31 ### Status files ###
32
33 Structure identical to job headers, but they do not contain a body.
34
35 Known fields:
36
37 Time: <timestamp>               UNIX timestamp of the last status change
38 Status: <code>                  Machine-readable status of the job:
39                                 NOPING - host does not respond to ping
40                                 NOXFER - transfer of the job body to a temporary file
41                                      on the host has failed
42                                 OK - job executed successfully (however, the job will
43                                      be removed from the queue immediately, so you are
44                                      not likely to see this code)
45                                 FAILED - job failed to execute (i.e., it returned
46                                          a non-zero exit code)
47                                 INTERR - internal error of BEX
48 Message: <msg>                  (Optional) human-readable message explaining the status