page requests: Slurm commands

[eviatarbach]

Slurm is a job scheduler widely used on supercomputers. There are a few commands used to interface with it that I think it would be useful to add to tldr: https://slurm.schedmd.com/man_index.html, https://slurm.schedmd.com/pdfs/summary.pdf

Commands:

• sacct (displays accounting data for all jobs and job steps in the Slurm job accounting log or Slurm database)
• sacctmgr (Used to view and modify Slurm account information.)
• salloc (Obtain a Slurm job allocation (a set of nodes), execute a command, and then release the allocation when the command is finished.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sattach (Attach to a Slurm job step.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sbatch (Submit a batch script to Slurm.)
• sbcast (transmit a file to the nodes allocated to a Slurm job.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• scancel (Used to signal jobs or job steps that are under the control of Slurm.)
• scontrol (Used view and modify Slurm configuration and state.)
• scontab (Manage Slurm crontab files.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• scrun (An OCI runtime proxy for slurm.) → Page request: scrun #11991
• sdiag (scheduling diagnostic tool.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sinfo (view information about Slurm nodes and partitions.)
• sprio (view the factors that comprise a job's scheduling priority) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sh5util (merge utility for acct_gather_profile plugin.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• squeue (view information about jobs located in the Slurm scheduling queue.)
• sreport (Generate reports from the slurm accounting data.)
• srun (Run parallel jobs)
• sshare (Tool for listing the shares of associations to a cluster.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sstat (Display various status information of a running job/step.)
• strigger (Used set, get or clear Slurm trigger information.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651
• sview (graphical user interface to view and modif. Slurm state.) → salloc, sattach, sbcast, sdiag, sprio, sshare, strigger, sview, sh5util, scrun, scrontab: add pages #11651

Daemons/other:

• slurmctld (The central management daemon of Slurm.) → slurm*: add pages #11133
• slurmd (The compute node daemon for Slurm.) → slurm*: add pages #11133
• slurmdbd (Slurm Database Daemon.) → slurm*: add pages #11133
• slurmrestd (The Slurm REST API daemon.) → slurm*: add pages #11133
• slurmstepd (The job step manager for Slurm.) → slurm*: add pages #11133
  spank (Slurm Plug-in Architecture for Node and job (K)control) → slurm*: add pages #11133

[sbrl]

Thanks for requesting this page, @eviatarbach! It sounds like it would be a great addition to tldr-pages. Do you want to have a go yourself?

Pages are best created by people who understand the command they are about.

If you do, take a quick read of CONTRIBUTING.md, which guides you through the process of creating a new page here. Then, just simply send a pull request to this repository - and if you need any assistance, just ask :-)

[eviatarbach]

Yes, I will work on it!

Thanks.

[npalladium]

It looks like all of them have not been added. I'll try to do that in the coming few days as I'm working with slurm right now.

[sbrl]

Thanks, @npalladium! That would be great ❤️ I'm using Slurm myself too.

[npalladium]

A few more commands are left. The only one that I actually use and that is not present is sstat, I think. Will do that later today.

[npalladium]

@navarroaxel, I think there are a few more commands remaining. Could you consider keeping this issue open?

[navarroaxel]

@npalladium sure, the merge closed this, not me 😄.
Could you list the commands like is done in issue 3953 to know when this is done?

[npalladium]

One #4689 and #4646 are merged, that should leave us with the following:

• sbcast
• salloc

(Not quite sure this is what you wanted though.)

[sbrl]

Merged #4689 & #4646 :D

[bl-ue]

I'm going to edit this issue's description and add all slurm commands that we have done/need to do.

[bl-ue]

So we've got done 10 of 21 slurm commands, and 0 of 6 daemon commands. The description is updated.

[bl-ue]

@npalladium feel up to adding some more?

[npalladium]

Of the commands left, I only use slurm and salloc. I can add those in the coming couple of days. As for the daemons, I'm not quite sure what to add.

[bl-ue]

We don't have to add the daemons (although it would be nice). I just saw them and thought it would be a good idea to suggest them.

I can add those in the coming couple of days

If you don't mind, please do. Thank you!

[npalladium]

That still leaves some commands that I don't use at all. I could try them out and see if I can add something as a first attempt, but I don't think that is ideal.

…

On Sat, Jan 2, 2021, 22:36 bl-ue ***@***.***> wrote: We don't have to add the daemon (although it would be nice). I just saw them and though it would be nice to suggest them. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2068 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AINGXXMWQRTDFFDRTBSQ6QLSX5G7ZANCNFSM4E2KQ53A> .

-- Disclaimer:- This footer text is to convey that this email is sent by one of the users of IITH. So, do not mark it as SPAM.

[bl-ue]

Don't bother @npalladium. Someone will come along, maybe me myself!

[sbrl]

Does anyone else with access to a Slurm system have an interactive command, or is it something specific to my University's HPC? If it's common, I'll write a page for it.

[bl-ue]

I can't find a reference to it on the Slurm docs @sbrl so maybe you do only have it. Can you send the output of --version, --help, etc., or whatever is appropriate for it?

[sbrl]

Oh, that's interesting. It's a symlink to salloc.

$ interactive --version
slurm 15.08.8
$ interactive --help
Usage: salloc [OPTIONS...] [executable [args...]]

.....

I think the symlink is in place to make it easy for researchers who don't have as much Linux experience. It's also convenient to remember :D

[xuzhangheng]

Hi,
I would like to contribute Daemons/other part of this document.

[sbrl]

@xuzhangheng: No need to ask! Just open a pull request, referencing this issue (i.e. #2068) in the description :-)

[sbrl]

Closed by mistake; #11991 is the last one on the list

[sbrl]

Just read #11991 - this issue was closed because scrun is technically not part of the core Slurm CLI. Congrats to everyone for helping with this, and especially @gutjuri for their hurculean efforts in #11651!

🎉 🎉 🎉