X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=NOTES;h=366a4092130fad07a487870524b62fc4c8f9d4df;hb=HEAD;hp=71d7fe92ee9d3cb649cdf368a5b1fac2ced73ce5;hpb=07d043c624f4450e46acc424c553bb85bbecca5f;p=bex.git diff --git a/NOTES b/NOTES index 71d7fe9..366a409 100644 --- a/NOTES +++ b/NOTES @@ -9,8 +9,10 @@ /.log (Optional) transcript of output produced by the job (including previous failed attempts) -/jobs/.job All jobs issued on this queue, including those which +/jobs/ All jobs issued on this queue, including those which are no longer queued for any machine + /.job Description of the job (see below) + /.attach/ A directory containing attachments (if any) /history// Successfully completed jobs (their .job, .stat and .log files) are moved here if the keep_history config switch is set. @@ -32,6 +34,13 @@ Known header fields: ID: Identifier of the job, unique in the scope of a queue Subject: Subject to be displayed to the user +Prep: Run in a shell before the job body is executed; + $HOST contains the name of the host. This is useful for + example if you want to transfer data to the host by rsync. + +Whenever a user command wants a job ID, it accepts any substring starting +at a component boundary (start of the ID or a "-"), as long as the substring +is unique. ### Status files ### @@ -40,15 +49,31 @@ Structure identical to job headers, but they do not contain a body. Known fields: Time: UNIX timestamp of the last status change -Status: Machine-readable status of the job: - NOPING - host does not respond to ping - NOXFER - transfer of the job body to a temporary file - on the host has failed - RUN - job is running (present only in log files) - OK - job executed successfully (however, the job will - be removed from the queue immediately, so you are - not likely to see this code) - FAILED - job failed to execute (i.e., it returned - a non-zero exit code) - INTERR - internal error of BEX +Status: Machine-readable status of the job (see below) Message: (Optional) human-readable message explaining the status + +### Status codes ### + +FAILED Job failed to execute (i.e., it returned a non-zero exit code) +INTERR Internal error of BEX (e.g., failed to read job prolog file) +NEW Newly inserted job, which did not run yet +NOPING Host does not respond to ping +NOXFER Transfer of the job body to a temporary file on the host has failed +OK Job finished successfully (this is usually not seen in the queue, since + finished jobs are immediately deleted or moved to the history) +PREP Running preparatory commands (i.e., those present in Prep header field) +PREPFAIL Preparatory commands failed (i.e., those present in Prep header field) +REMOVED Job removed from the queue (behavior similar to OK) +RUN Job is running + +Additional status codes recorded in the log files: + +REQUEUE Attempted to put on a queue, but it already was there + +Additional status codes sent only over status FIFO: + +DONE Done with the host (job equals "-") +INIT Host or job ready, preparing to execute jobs +LOCKED Host or job not available, because it is locked by another brun +PING Trying to ping the host (job equals "-") +SEND Sending job to the host