uge_submit_workers(1)

📦
version 7.15.9 · 2 versions
, in ubuntu resolute, ubuntu stonking

💖 uge_submit_workers — the manual page, but make it cute 💖

okay so bestie, you're reading the uge_submit_workers(1) page from the Cooperative Computing Tools manual, section 1. let's get into it 🫶

✨ NAME ✨

uge_submit_workers — submit work_queue_worker to a Univa Grid Engine (UGE) cluster. it's giving "i have a cluster and i want workers on it" energy 👑

✨ SYNOPSIS ✨

when auto mode is not enabled for the worker, you go like this:

uge_submit_workers [options] <servername> <port> <num-workers>

and when auto mode is enabled for the worker, you go like this:

uge_submit_workers [options] <num-workers>

✨ DESCRIPTION ✨

so basically, uge_submit_workers schedules the execution of work_queue_worker(1) on the Univa Grid Engine (UGE) by going through its job submission interface, which is qsub. 💅

the number of work_queue_worker that get scheduled and run? that's literally the num-workers argument, no cap.

the servername and port arguments specify the hostname and port number of the manager that work_queue_worker is gonna connect to. 🦋 but listen — these two arguments become optional when the auto mode option is specified for work_queue_worker. iconic behavior tbh.

✨ OPTIONS ✨

  • -M, --manager-name=<name> — the name of the preferred manager for the worker. (auto mode enabled ✨)
  • -C, --catalog=<catalog> — set the catalog server for work_queue_worker to <catalog>. the <catalog> format is HOSTNAME:PORT. 🌸
  • -C, --catalog=<catalog> — yep, it's here again, same as above: set the catalog server for work_queue_worker to <catalog>, and the <catalog> format is HOSTNAME:PORT. (the page really said it twice and honestly? consistency 💀)
  • -t, --timeout=<seconds> — abort work_queue_worker after this much idle time. default is 900s. ⏰
  • -d, --debug=<subsystem> — enable debugging on the worker for this subsystem. (pro tip from the page itself: try -d all to start 🔥)
  • -w, --tcp-window-size=<size> — set the TCP window size.
  • -i, --min-backoff=<time> — set the initial value for the backoff interval, for when the worker fails to connect to a manager. default is 1s.
  • -b, --max-backoff=<time> — set the maximum value for the backoff interval, for when the worker fails to connect to a manager. default is 60s.
  • -z, --disk-threshold=<size> — set the available disk space threshold, in MB. when it gets exceeded, the worker will clean up and reconnect. default is 100MB. 🧹
  • -A, --arch=<arch> — set the architecture string for the worker to report to the manager, instead of whatever value is in uname.
  • -O, --os=<os> — set the operating system string for the worker to report to the manager, instead of whatever value is in uname.
  • -s, --workdir=<path> — set the location for creating the working directory of the worker.
  • -P, ----password=<file> — password file to authenticate workers to the manager. 🔐 (yes, that's four dashes before password, exactly like the page says — copy it character for character, bestie)
  • --cores=<cores> — set the number of cores each worker should use. 0 means auto. default is 1.
  • --memory=<size> — manually set the amount of memory, in MB, reported by this worker.
  • --disk=<size> — manually set the amount of disk, in MB, reported by this worker.
  • --scratch-dir=<path> — set the scratch directory location created on the local machine. default is ${USER}-workers. 🎀
  • -j — use a job array to submit workers.
  • --p <parameters> — UGE qsub parameters.
  • -h, --help — show the help message. 🙈

✨ EXIT STATUS ✨

  • on success, it returns zero. 🥳
  • on failure, it returns non-zero. 😭

✨ EXAMPLES ✨

want to submit 10 worker instances to run on UGE and connect to a specific manager? say less:

uge_submit_workers manager.somewhere.edu 9123 10

want to submit 10 work_queue_worker instances to run on UGE in auto mode, with their preferred project name set to Project_A and the abort timeout set to 3600 seconds? periodt:

uge_submit_workers -a -t 3600 -M Project_A 10

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.

✨ SEE ALSO ✨

and that's the whole page, bestie 🌈 that was CCTools 7.15.9 FINAL energy from top to bottom — go submit some workers, you absolute icon 💅✨👑

📦 where this page comes from