| vine_factory(1) | Cooperative Computing Tools | vine_factory(1) |
vine_factory - maintain a pool of TaskVine workers on a batch system.
vine_factory -M <project-name> -T <batch-type> [options]
vine_factory submits and maintains a number of vine_worker(1) processes on various batch systems, such as Condor and UGE. All the workers managed by a vine_factory process will be directed to work for a specific manager, or any set of managers matching a given project name. vine_factory will automatically determine the correct number of workers to have running, based on criteria set on the command line. The decision on how many workers to run is reconsidered once per minute.
By default, vine_factory will run as many workers as the indicated managers have tasks ready to run. If there are multiple managers, then enough workers will be started to satisfy their collective needs. For example, if there are two managers with the same project name, each with 10 tasks to run, then vine_factory will start a total of 20 workers.
If the number of needed workers increases, vine_factory 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, vine_factory 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 vine_factory will consider the capacity reported by each manager. The capacity is the estimated number of workers that the manager thinks it can handle, based on the task execution and data transfer times currently observed at the manager. With the -c option on, vine_factory will consider the manager's capacity to be the maximum number of workers to run.
If vine_factory receives a terminating signal, it will attempt to remove all running workers before exiting.
General options:
Concurrent control options:
Resource management options:
Set the number of cores requested per worker.
Set the number of GPUs requested per worker.
Set the amount of memory (in MB) per worker.
Set the amount of disk (in MB) per worker.
Autosize worker to slot (Condor, Mesos, K8S).
Worker environment options:
Environment variable to add to worker.
Extra options to give to worker.
Alternate binary instead of vine_worker.
Wrap factory with this command prefix.
Options specific to batch systems:
On success, returns zero. On failure, returns non-zero.
Suppose you have a TaskVine manager with a project name of "barney". To maintain workers for barney, do this:
vine_factory -T condor -M barney
To maintain a maximum of 100 workers on an UGE batch system, do this:
vine_factory -T uge -M barney -W 100
To start workers such that the workers exit after 5 minutes (300s) of idleness:
vine_factory -T condor -M barney -t 300
If you want to start workers that match any project that begins with barney, use a regular expression:
vine_factory -T condor -M "barney.*" -t 300
If running on condor, you may manually specify condor requirements:
vine_factory -T condor -M barney --condor-requirements 'MachineGroup == "disc"' --condor-requirements 'has_matlab == true'
Repeated uses of condor-requirements are and-ed together. The previous example will produce a statement equivalent to:
requirements = ((MachineGroup == "disc") && (has_matlab == true))
Use the configuration file my_conf:
vine_factory -Cmy_conf
my_conf should be a proper JSON document, as:
{
"manager-name": "my_manager.*",
"max-workers": 100,
"min-workers": 0
}
Valid configuration fields are:
manager-name foremen-name min-workers max-workers workers-per-cycle task-per-worker timeout worker-extra-options condor-requirements cores memory disk
The capacity measurement currently assumes single-core tasks running on single-core workers, and behaves unexpectedly with multi-core tasks or multi-core workers.
The Cooperative Computing Tools are Copyright (C) 2022 The University of Notre Dame. This software is distributed under the GNU General Public License. See the file COPYING for details.
| CCTools 7.13.1 FINAL |