GE_SHEPHERD(8)        Grid Engine Administrative Commands       GE_SHEPHERD(8)



[1mNAME[0m
       ge_shepherd - Grid Engine single job controlling agent

[1mSYNOPSIS[0m
       [1mge_shepherd[0m

[1mDESCRIPTION[0m
       [4mge_shepherd[24m provides the parent process functionality for a single Grid
       Engine job.  The parent functionality is necessary on UNIX  systems  to
       retrieve  resource usage information (see [4mgetrusage[24m(2)) after a job has
       finished. In addition, the [4mge_shepherd[24m forwards  signals  to  the  job,
       such  as the signals for suspension, enabling, termination and the Grid
       Engine checkpointing signal (see [4mge_ckpt[24m(1) for details).

       The [4mge_shepherd[24m receives information about the job to be  started  from
       the [4mge_execd[24m(8).  During the execution of the job it actually starts up
       to 5 child processes. First a prolog script is run if this  feature  is
       enabled  by  the  [1mprolog  [22mparameter  in the cluster configuration. (See
       [4mge_conf[24m(5).)  Next a parallel environment startup procedure is  run  if
       the job is a parallel job. (See [4msge_pe[24m(5) for more information.)  After
       that, the job itself is run, followed by a parallel  environment  shut-
       down  procedure  for  parallel  jobs,  and  finally an epilog script if
       requested by the [1mepilog [22mparameter in  the  cluster  configuration.  The
       prolog  and  epilog scripts as well as the parallel environment startup
       and shutdown procedures are to be provided by the Grid Engine  adminis-
       trator  and  are  intended for site-specific actions to be taken before
       and after execution of the actual user job.

       After the job has finished and the epilog script is processed, [4mge_shep-[0m
       [4mherd[24m  retrieves resource usage statistics about the job, places them in
       a job specific subdirectory of  the  [4mge_execd[24m(8)  spool  directory  for
       reporting through [4mge_execd[24m(8) and finishes.

       [4mge_shepherd[24m  also  places  an  exit status file in the spool directory.
       This exit status can be viewed with qacct -j JobId (see  [4mqacct[24m(1));  it
       is  not the exit status of [4mge_shepherd[24m itself but of one of the methods
       executed by [4mge_shepherd.[24m  This exit status can have  several  meanings,
       depending  on in which method an error occurred (if any).  The possible
       methods are: prolog, parallel start, job, parallel stop,  epilog,  sus-
       pend, restart, terminate, clean, migrate, and checkpoint.

       The following exit values are returned:

       0      All methods: Operation was executed successfully.

       99     Job script, prolog and epilog: When [4mFORBID_RESCHEDULE[24m is not set
              in the configuration (see [4mge_conf[24m(5)), the job  gets  re-queued.
              Otherwise see "Other".

       100    Job  script,  prolog and epilog: When [4mFORBID_APPERROR[24m is not set
              in the configuration (see [4mge_conf[24m(5)), the job  gets  re-queued.
              Otherwise see "Other".

       Other  Job script: This is the exit status of the job itself. No action
              is taken upon this exit status because the meaning of this  exit
              status is not known.
              Prolog,  epilog  and  parallel  start: The queue is set to error
              state and the job is re-queued.
              Parallel stop: The queue is set to error state, but the  job  is
              not  re-queued.  It  is assumed that the job itself ran success-
              fully and only the clean up script failed.
              Suspend, restart, terminate, clean, and migrate: Always success-
              ful.
              Checkpoint: Success, except for kernel checkpointing: checkpoint
              was not successful, did not happen (but migration will happen by
              Grid Engine).

[1mRESTRICTIONS[0m
       [4mge_shepherd[24m should not be invoked manually, but only by [4mge_execd[24m(8).

[1mFILES[0m
       [1msgepasswd  contains  a  list  of  user  names   and   their correspond-[0m
       [1ming encrypted passwords. If available, the  password   file   will   be[0m
       [1mused   by  sge_shepherd. To change the contents of this file please use[0m
       [1mthe sgepasswd command. It is not advised to  change that file manually.[0m
       [4m<execd_spool>/job_dir/<job_id>[24m     job specific directory

[1mSEE ALSO[0m
       [4mge_intro[24m(1), [4mge_conf[24m(5), [4mge_execd[24m(8).

[1mCOPYRIGHT[0m
       See [4mge_intro[24m(1) for a full statement of rights and permissions.



GE 6.2u2                 $Date: 2007/07/19 09:04:33 $           GE_SHEPHERD(8)
