oar_resources_add(8)

📦
version 2.6.1 · 3 versions
, in debian trixie, ubuntu questing

💖 oar_resources_add — NAME 💖

oar_resource_add — bestie, it's yet another helper script to define OAR resources ✨ (yes, the manual page is oar_resources_add(8), the command itself is oar_resource_add, iykyk, we love a little naming chaos 🫶)

🌸 SYNOPSIS 🌸

oar_resource_add -H <# of hosts> [options]

🎀 DESCRIPTION 🎀

okay so. this tool generates the oarproperty and oarnodesetting commands that you need to create OAR resources, and it follows the whole host / cpu / core (/ thread) hierarchy, possibly with GPU alongside. it's giving very structured. very organized. we stan 💅

REMINDER: each physical element (each cpu, each core, each thread, each gpu) must have a unique identifier in the OAR resources database. no duplicates, no cap. 🚫

if some resources already exist in the database (like, say, from a previously installed cluster 👀), you can either pass offsets on the command line, or let the auto-offset option guess them for you — that way the identifiers for the newly created resources stay unique. slay.

this tool is also a good example of how one can create OAR resources using script loops and the oarnodesetting command. if it does not exactly fit your needs, feel free to read the script code and adapt it. main character energy: read the source, bestie 📖✨

✨ OPTIONS ✨

  • -T, --use-threads — use (create) the thread property. thread girlies rise 🧵
  • -H, --hosts <#> — the number of hosts.
  • -C, --cpus <#> — the number of cpu per host.
  • -c, --cores <#> — the number of core per cpu.
  • -t, --threads <#> — the number of threads per core.
  • -g, --gpus <#> — the number of gpus per host.
WARNING, not all hardware configurations are supported: for multi-GPU configurations, the # of cores per cpu must be a multiple of the # of gpus per cpu. do the math first bestie, it's not optional 😭

if not set, no gpu resources is handled. (no gpus, no problem 💅)

  • --host-prefix <str> — hostname prefix (default: "node-").
  • --host-suffix <str> — hostname suffix (e.g. ".domain").
  • --host0 <#> — first host id to use.
  • --cpu0 <#> — first cpu id to use.
  • --core0 <#> — first core id to use.
  • --thread0 <#> — first thread id to use.
  • --gpu0 <#> — first gpu id to use.
  • --cpusets <#> — # of cpusets on host (mainly useful for development purposes when one wants to emulate more cores than systems really have). fake it till you make it 🫶
  • --cputopo <list|RR> — provide the topology for the CPUs/cores/threads affinity (see hwloc), given a ordered list of the Linux CPU ids (as used in cpuset.cpus).

or, given the RR value, try to match a round-robin distribution of the core ids, with optionally HyperThreads as well. 🔄

  • --gpudevices <#> — # of gpudevices on host (mainly useful for development purposes when one wants to emulate more GPUs than systems really have). manifesting extra GPUs ✨
  • --gpudevice-prefix <str> — path prefix to use for the path of the device file of the GPU (e.g.: /dev/nvidia).
  • --gputopo <list> — provide the topology for the CPUs/GPUs affinity (see hwloc), given a ordered list of the Linux GPU device ids.
  • -A, --append <str> — append a text string (extra properties).
  • -o, --write-to <file> — write commands to file.
  • -p, --no-create-properties — do not generate oarproperty commands.
  • -a, --auto-offset — guess the next host/cpu/core/thread/gpu ids to use from the OAR database (unless host0/cpu0/core0/thread0/gpu0 is set).
WARNING: properties must already exist in your database or you will get errors. fr fr, don't skip this step 💀
  • -Y, --yaml — generate YAML output. yaml girlies, this one's for you 🌈
  • -h, --help — display usage.

⚠️ WARNING ⚠️

the oar_resource_add tool does not look at the actual hardware topology of the target machines. core and GPU device affinity to CPU may not be correct. 😬

see the hwloc commands for instance to find out the correct topology and affinity, and use the --cputopo and --gputopo options accordingly. that's the whole vibe check right there 🧚

🔍 SEE ALSO 🔍

👑 COPYRIGHTS 👑

Copyright 2003-2018 Laboratoire d'Informatique de Grenoble (http://www.liglab.fr). This software is licensed under the GNU General Public License Version 2 or above. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

and that's the whole page bestie!! 💜 this came from the oar_resources_add manual, dated 2025-03-24, and it lives with the rest of the OAR commands ✨ go forth and add your resources, you absolute icon 🎀💖

📦 where this page comes from