.TH "work_queue_worker" 1 "" "CCTools 8.0.0 DEVELOPMENT" "Cooperative Computing Tools"

.SH NAME
.LP
\fBwork_queue_worker\fP - worker process for executing tasks
dispatched through Work Queue

.SH SYNOPSIS
.LP
\FC\fBwork_queue_worker [options] <managerhost> <port>\fP\FT

\FC\fBwork_queue_worker [options] <managerhost:port]>\fP\FT

\FC\fBwork_queue_worker [options] "<managerhost:port;[managerhost:port;managerhost:port;...]>\fP\FT"

\FC\fBwork_queue_worker [options] -M <projectname>\fP\FT

.SH DESCRIPTION
.LP

\fBwork_queue_worker\fP is the worker process for executing tasks dispatched
from a manager application built using the \fBWork Queue\fP API. \fBwork_queue_worker\fP
connects to the manager application, accepts, runs, and returns tasks dispatched to it.

.PP

The \fBmanagerhost\fP and \fBport\fP arguments specify the hostname and port
number of the manager application for work_queue_worker to connect. Several
managerhosts and ports may be specified, separated with a semicolon (;), with the
worker connecting to any of the managers specified (When specifying multiple
managers, remember to escape the ; from shell interpretation, for example, using
quotes.)

Alternatevely, the manager may be specified by name, using the \fB-M\fP option.

.PP

\fBwork_queue_worker\fP can be run locally or deployed remotely on any of the
grid or cloud computing environments such as SGE, PBS, SLURM, and HTCondor using
\fBsge_submit_workers(1)\fP, \fBpbs_submit_workers(1)\fP, \fBslurm_submit_workers()\fP, and \fBcondor_submit_workers(1)\fP respectively.

.SH OPTIONS
.LP
.LP
.TP
.B \ -v
.
Show version string.
.TP
.B \ -h
.
Show this help message.
.TP
\fB-N\fP, \fB-\--M\fP=\fI<manager-name>\fP
.
Set the name of the project this worker should work for.  A worker can have multiple projects.
.TP
\fB-C\fP, \fB-\-catalog\fP=\fI<catalog>\fP
.
Set catalog server to <catalog>. Format: HOSTNAME:PORT
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<flag>\fP
.
Enable debugging for the given subsystem. Try -d all as a start.
.TP
\fB-o\fP, \fB-\-debug-file\fP=\fI<file>\fP
.
Write debugging output to this file. By default, debugging is sent to stderr (":stderr"). You may specify logs to be sent to stdout (":stdout") instead.
.TP
.BI \ --debug-max-rotate \ <bytes>
.
Set the maximum file size of the debug log.  If the log exceeds this size, it is renamed to "filename.old" and a new logfile is opened.  (default=10M. 0 disables)
.TP
.B \ --debug-release-reset
.
Debug file will be closed, renamed, and a new one opened after being released from a manager.
.TP
.B \ --foreman
.
Enable foreman mode.
.TP
\fB-f\fP, \fB-\-foreman-name\fP=\fI<name>\fP
.
Set the project name of this foreman to <project>. Implies --foreman.
.TP
.BI \ --foreman-port \ <port[:highport]>
.
 Set the port for the foreman to listen on.  If <highport> is specified the port is chosen from between <port> and <highport>. Implies --foreman.
.TP
\fB-Z\fP, \fB-\-foreman-port-file\fP=\fI<file>\fP
.
Select port to listen to at random and write to this file.  Implies --foreman.
.TP
\fB-F\fP, \fB-\-fast-abort\fP=\fI<mult>\fP
.
Set the fast abort multiplier for foreman (default=disabled).
.TP
.BI \ --specify-log \ <logfile>
.
Send statistics about foreman to this file.
.TP
\fB-P\fP, \fB-\-password\fP=\fI<pwfile>\fP
.
Password file for authenticating to the manager.
.TP
\fB-t\fP, \fB-\-timeout\fP=\fI<time>\fP
.
Abort after this amount of idle time. (default=900s)
.TP
.B \ --parent-death
.
Exit if parent process dies.
.TP
\fB-w\fP, \fB-\-tcp-window-size\fP=\fI<size>\fP
.
Set TCP window size.
.TP
\fB-i\fP, \fB-\-min-backoff\fP=\fI<time>\fP
.
Set initial value for backoff interval when worker fails to connect to a manager. (default=1s)
.TP
\fB-b\fP, \fB-\-max-backoff\fP=\fI<time>\fP
.
Set maxmimum value for backoff interval when worker fails to connect to a manager. (default=60s)
.TP
\fB-A\fP, \fB-\-arch\fP=\fI<arch>\fP
.
Set the architecture string the worker reports to its supervisor. (default=the value reported by uname)
.TP
\fB-O\fP, \fB-\-os\fP=\fI<os>\fP
.
Set the operating system string the worker reports to its supervisor. (default=the value reported by uname)
.TP
\fB-s\fP, \fB-\-workdir\fP=\fI<path>\fP
.
Set the location where the worker should create its working directory. (default=/tmp)
.TP
.BI \ --bandwidth \ <mbps>
.
Set the maximum bandwidth the foreman will consume in Mbps. (default=unlimited)
.TP
.BI \ --cores \ <n>
.
Set the number of cores this worker should use.  Set it to 0 to have the worker use all of the available resources. (default=1)
.TP
.BI \ --gpus \ <n>
.
Set the number of GPUs this worker should use. (default=0)
.TP
.BI \ --memory \ <mb>
.
Manually set the amount of memory (in MB) reported by this worker.
.TP
.BI \ --disk \ <mb>
.
Manually set the amount of disk space (in MB) reported by this worker.
.TP
.BI \ --wall-time \ <s>
.
Set the maximum number of seconds the worker may be active.
.TP
.BI \ --feature \ <feature>
.
Specifies a user-defined feature the worker provides (option can be repeated).
.TP
.BI \ --volatility \ <chance>
.
Set the percent chance per minute that the worker will shut down (simulates worker failures, for testing only).


.SH FOREMAN MODE
.LP

\fBwork_queue_worker\fP can also be run in \fBforeman\fP mode, in which it connects to a
manager as a worker while acting as a manager itself.  Any tasks the foreman receives from
its manager are sent to its subordinate worker processes.

.PP

\fBForeman\fP mode is enabled by either specifying a port to listen on using the \fB-f <port>\fP option or by
setting the mode directly with the \fB--foreman\fP option.  The foreman can be directed to advertise its
presence on the \fBcatalog_server()\fP with the \fB-N <project name>\fP flag, which other workers can use to
contact the foreman.

.SH EXIT STATUS
.LP
On success, returns zero.  On failure, returns non-zero.

.SH EXAMPLES
.LP

To run \fBwork_queue_worker\fP to join a specific manager process running on host \FCmanager.somewhere.edu\FT port 9123:
.fam C
.nf
.nh
.IP "" 8
% work_queue_worker manager.somewhere.edu 9123
.fi
.hy
.fam
.P

To run \fBwork_queue_worker\fP in auto mode with debugging turned on for all subsystems and
to accept tasks only from a manager application with project name set to project_A:
.fam C
.nf
.nh
.IP "" 8
% work_queue_worker -a -d all -M project_A
.fi
.hy
.fam
.P

To run \fBwork_queue_worker\fP as a foreman working for project_A and advertising itself as foreman_A1 while listening on port 9123:
.fam C
.nf
.nh
.IP "" 8
% work_queue_worker --foreman -M project_A -N foreman_A1 -f 9123
.fi
.hy
.fam
.P

.SH COPYRIGHT
.LP

The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.

.SH SEE ALSO
.LP


.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBWork Queue User Manual\fP
.IP \(bu 4
\fBwork_queue_worker(1)\fP \fBwork_queue_status(1)\fP \fBwork_queue_factory(1)\fP \fBcondor_submit_workers(1)\fP \fBsge_submit_workers(1)\fP \fBtorque_submit_workers(1)\fP