A simple system resource reservation manager.
resman [-h] [-d DURATION] [-x [COMMAND ...]] [-r [REASON ...]] [-R] [-c] [-u USER]
A simple system resource allocation program. Persistent state stored in /etc/res_lock. This program does not impose any actual lock on system resource usage; it only keeps track of which user (if any) has laid claim to it for the time being, and if applicable how long they have it reserved for. The purpose of this is to prevent two people accidentally running experiments at the same time.
| Flag(s) | Description |
|---|---|
| -h, --help | Show this help message and exit |
| -d DURATION, --duration DURATION | How long to reserve server use for (e.g. 1h30m, 25m, 4h) |
| -x [COMMAND ...], --run [COMMAND ...] | Reserve the server until COMMAND finishes. quotes (') are needed around COMMAND if it contains '-'s, otherwise they're optional. |
| -r [REASON ...], --reason [REASON ...] | What experiment are you running? Default is blank. Completely optional. |
| -c, --confirm | Interactively tell the user the current status of things. If the server is reserved, they are prompted to press enter to confirm they understand this. |
| -u USER, --user USER | Who is using the server during the reservation? Default is your username. |
Can also be run with no arguments, to check status. Exits with 0 if not reserved, or 1 if
currently reserved. Just echo $? afterwards.
Install the program with
sudo ./install.shTo more easily see when someone is running, you can use the code from prompt-alert.sh, which
sets the global environment variable RESMAN_ALERT to a red ! when the system is reserved. This
is updated every time you refresh the prompt. It also includes a new PS1 variable to include
this alert into the default prompt.
The 'RESMAN_ALERT' variable can also be manually included in custom prompts.
For example, append this code to the end of /etc/bash.bashrc.local and /etc/zsh.zshrc.local:
cat ./prompt-alert.sh | sudo tee -a /etc/bash.bashrc.local > /dev/null
cat ./prompt-alert.sh | sudo tee -a /etc/zsh.zshrc.local > /dev/nullAlternatively you may source path/to/prompt-alert.sh at the end of your bashrc.
Install development dependencies inside a virtual environment:
$ python3 -m venv venv
$ source venv/bin/activate
(venv)$ pip install -e .[dev]
(venv)$ pre-commit install