By default, work_queue_pool will run as many workers as the indicated masters have tasks ready to run. If there are multiple masters, then enough workers will be started to satisfy their collective needs. For example, if there are two masters with the same project name, each with 10 tasks to run, then work_queue_pool will start a total of 20 workers.
If the number of needed workers increases, work_queue_pool will submit more workers to meet the desired need. However, it will not run more than a fixed maximum number of workers, given by the -W option.
If the need for workers drops, work_queue_pool does not remove them immediately, but waits to them to exit on their own. (This happens when the worker has been idle for a certain time.) A minimum number of workers will be maintained, given by the -w option.
If given the -c option, then work_queue_pool will consider the capacity reported by each master. The capacity is the estimated number of workers that the master thinks it can handle, based on the task execution and data transfer times currently observed at the master. With the -c option on, work_queue_pool will consider the master's capacity to be the maximum number of workers to run.
If work_queue_pool receives a terminating signal, it will attempt to remove all running workers before exiting.
-M,--master-name <project> | |
Name of a preferred project. A worker can have multiple preferred projects. | |
-T,--batch-type <type> | |
Batch system type: unix, condor, sge, workqueue, xgrid. (default is unix) | |
-w,--min-workers <workers> | |
Minimum workers running. (default=5) | |
-W,--max-workers <workers> | |
Maximum workers running. (default=100) | |
-c --capacity | Use worker capacity reported by masters. |
-P,--password <file> | |
Password file for workers to authenticate to master. | |
-t,--timeout <time> | |
Abort after this amount of idle time. | |
-E,--extra-options <options> | |
Extra options that should be added to the worker. | |
-S,--scratch <file> | |
Scratch directory. (default is /tmp/${USER}-workers) | |
-d,--debug <flag> | |
Enable debugging for this subsystem. | |
-o,--debug-file <file> | |
Write debugging output to this file. By default, debugging is sent to stderr (":stderr"). You may specify logs be sent to stdout (":stdout"), to the system syslog (":syslog"), or to the systemd journal (":journal"). | |
-h, --help | Show this screen. |
work_queue_pool -T condor -M barneyTo maintain a maximum of 100 workers on an SGE batch system, do this:
work_queue_pool -T sge -M barney -W 100To start workers according to the master's capacity, such that the workers exit after 5 minutes (300s) of idleness:
work_queue_pool -T condor -M barney -c -t 300If you want to start workers that match any project that begins with barney, use a regular expression:
work_queue_pool -T condor -M barney.\* -c -t 300