PALLOC(1)

📦 version 6.1.1~rc2, in ubuntu stonking

💅 palloc — ok bestie, let's get you some RESOURCES 💅

heyyy so this is palloc, and it lives in the OpenPMIx manual, section 1 (that's "user commands", iykyk). It's giving "I need compute and I need it NOW" energy. 🫶

✨ NAME ✨

palloc — request a resource allocation 🌈

📜 SYNOPSIS 📜

palloc [options]

That's it. That's the whole vibe. Options only, no positional drama up front (well, kind of — read the EXIT STATUS bit, bestie, there's a plot twist 🍓).

🦋 DESCRIPTION 🦋

okay so palloc lets you request an allocation of resources. You can use it as part of a job script, or just for an interactive session — whichever, it's your moment, main character energy ✨

And not only can you describe the resources you want, you can also hand over a job script or an application to be executed once that session gets established. Like, "here's my wishlist AND here's what to run when the wishlist comes true" 💖

Also lowkey important: palloc isn't only for brand-new requests. You can also use it to modify an existing allocation or allocation request — for example, extending its time limit, or changing the allocated resources. It's giving glow-up era 💅

🎀 OPTIONS 🎀

palloc accepts the following options:

-h | --help <arg0> — Show the help message. If you don't pass the optional argument, you get a generalized help message, kinda like the info right here. If you do pass an argument, you get a much more detailed help message for that specific command line option. So like, --help --nodes is you asking for the director's commentary 👑
-v | --verbose — Enable debug output. Turn it on when you want to see EVERYTHING. nosy bestie mode 🙈
-V | --version — Print version and exit. boom, done, bye 🦋
--uri <arg0> — Specify the URI of the server to which we are to connect, or the name of the file (specified as file:filename) that contains that info. So you either hand over the address directly or you hand over a file that's holding the address 💌
--namespace <arg0> — Namespace of the daemon to which we should connect 🏷️
--nspace <arg0> — Synonym for namespace. Same thing, shorter name, both iconic 💅
--pid <arg0> — PID of the daemon to which we should connect (int => PID, or file:<file> for a file containing the PID). Yeah that parenthesis is a lil unclosed in the original, we don't gatekeep, we just vibe 🫶
--system-server-first — First look for a system server and connect to it if found. peek first, commit later 👀
--system-server-only — Connect only to a system-level server. no plan B, no side quests, only system-level 🚫
--system-controller — Connect to the system controller 🎛️
--tmpdir <arg0> — Set the root for the session directory tree 🌳
--connect-order <arg0> — Specify search order for server connections — e.g., scheduler, system controller, system-level server, or local server. You're literally ranking your faves 📋
--wait-to-connect <arg0> — Delay specified number of seconds before trying to connect. a lil nap first 😴
--num-connect-retries <arg0> — Max number of times to try to connect. how many times we're willing to knock on the door 🚪
--request-id <arg0> — String identifier for this allocation request. name your request, make it searchable, it's giving personalized 🎀
-q | --queue <arg0> — Scheduler queue this request should be passed to for processing. get in line, bestie, literally 🚶♀️
-N | --nodes <arg0> — Number of nodes to be allocated. how many?? 🔢
-i | --image <arg0> — OS image to be provisioned on allocated nodes prior to initiating execution of specified job, or turning nodes over to an interactive session. dress the nodes up before the party starts 🎭
-x | --exclude <arg0> — Comma-delimited list of nodes that are to be excluded from consideration for scheduling this allocation. blocked. not on the guest list 🙅♀️
--wait-all-nodes — Wait for all nodes to be ready before starting execution of the specified job. no starting until EVERYONE is here 🫂
-w | --nodelist <arg0> — Comma-delimited list of ranges of specific nodes being requested [e.g., host0[1-5],host128]. Can also pass the argument as a filename using the file:<path> syntax. Ordering of names and/or duplicate names are ignored. so like, don't stress about the order or repeating yourself, it's not gonna count against you 💖
--uid <arg0> — Assign the resulting allocation to the specified user ID 🪪
--gid <arg0> — Assign the resulting allocation to the specified group ID 🪪
-t | --time <arg0> — Time limit on the assigned allocation. clock is ticking ⏰
--signal <arg0>[@arg1] — Send all processes executing within the allocated session the specified signal when it reaches the (optional) specified seconds of its end time. So: signal, and optionally when relative to the end. the wind-down notification 📣
-s | --share — Allocated resources can be shared with other allocations. sharing is caring, apparently 🫶
--extend <arg0> — Extend the specified existing session ID per the rest of the given request. more time, more time, greedy behavior and we respect it 👑
--shrink <arg0> — Shrink the specified existing session ID per the rest of the given request. ok giving some back, generous fr fr 🍓
--no-shell — Immediately exit after allocating resources, without running a command. Allocate and dip 💨
--begin <arg0> — Direct the scheduler to defer allocation until the specified time. "not now, later" 📅
-I | --immediate <arg0> — Exit if resources are not available within the time period specified. instant gratification or nothing 😤
-d | --dependency <arg0> — Defer the start of this session until the specified dependencies have successfully completed. can't start until the prerequisites finish their little arc 🌸
--do-not-wait — Submit the allocation request to the scheduler, but do not wait for the allocation to be assigned. Intended for use when submitting a job for batch execution. drop it and go 🏃♀️

🔥 EXIT STATUS 🔥

Returns 0 for success, non-zero error code if a problem occurred.

⚠️ bestie, listen: success does not necessarily translate to success of the requested operation, depending upon provided options — it may instead just mean that the request has been accepted for processing. So like, "we got your letter" ≠ "your letter got approved". Read the room, read the docs 💀

The command outputs the integer session ID of the resulting allocation. Or, if executed with the --do-not-wait option, a message indicating if the request has been accepted for processing.

Any command line arguments following the provided options are taken as the job script or executable to be run within the allocation (once assigned), and its attendant argv array. In this case, the allocation will terminate once the provided job script or executable completes. so the thing you tack on at the end rides along until it's done, and then everybody goes home 🎀

🌈 EXAMPLES 🌈

Examples of using this command.