beorun

Name

beorun --  Run a job on a Scyld Beowulf cluster using dynamically selected nodes.

Synopsis

beorun [-h, --help] [-V, --version] [--np PROCESSES ] [--allcpus, --all-cpus] [--all-local] [--no-local, --nolocal]
[--exclude NODE LIST ] [--map NODE LIST ] command [command-args...]

Description

The beorun program runs the specified program on a dynamically selected set of cluster nodes. It generates a Beowulf job map from the currently installed Beomap scheduler, and starts the program on each node specified in the map. The scheduling parameters from the command line and environment are the same as the beomap, and the resulting job map is identical to the job map that beomap would if generate at that instant in time for that program name.

The beorun command may be used to start applications that are not cluster aware or do not have their own scheduler interface.

Both command-line options and environment variables influence the resulting job map. Command-line options take precedence over the environment variable settings.

Options

The following options are available to the beorun program.

-h, --help, -u, --usage

Print the command usage message on stdout and exit. When one of these options is recognized in the option list, all following options will be ignored.

-V

Print the command version number on stdout and exit. Any following options will be ignored.

-np PROCESSES

Specify the number of processes to create. This option uses beomap to create a process map, selecting the least loaded processors in the cluster. The number of processors beomap selects will equal the number specified by the "PROCESSES" parameter.

-no-local, --nolocal

Do not include the master in the process map. For MPI jobs, this puts the "rank 0" job on a compute node instead of the master.

-all-local

Create a process map consisting entirely of master node entries.

-all-cpus

Create a process map consisting of all up nodes, with each node number repeated the number of CPUs on that node.

--exclude NODE LIST

Do not include the listed nodes in the process map. The NODE LIST is a colon-separated list of nodes to be excluded from the map of processors to be used to run the job.

--map NODE LIST

Create a process map consisting of the colon-separated list of nodes as returned by beomap.

Unrecognized options and invalid option formats are reported on stderr and the command exits with exit status 1 (invalid option) or 2 (no command specified or invalid command).

NOTE: beorun does not pass information from stdin to applications. In cases where an application must read data from stdin, it is suggested that bpsh be used instead. Please see the bpsh man page for usage information; command line options for bpsh are similar to those for beorun but not exactly the same.

Examples

Run uptime on any two available cluster compute nodes:

[user@cluster user]$ beorun --np 2 --no-local uptime
11:05am  up 2 days, 11:16,  0 users,  load average: 0.05, 0.24, 0.65
 11:05am  up 2 days, 11:16,  0 users,  load average: 0.01, 0.07, 0.37

See Also

beomap(1), bpsh(1), mpprun(1), beonpc(1), and the User's Guide.