Tldr: 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:

• [x] [sacct](https://slurm.schedmd.com/sacct.html) (displays accounting data for all jobs and job steps in the Slurm job accounting log or Slurm database)
• [x] [sacctmgr](https://slurm.schedmd.com/sacctmgr.html) (Used to view and modify Slurm account information.)
• [ ] [salloc](https://slurm.schedmd.com/salloc.html) (Obtain a Slurm job allocation (a set of nodes), execute a command, and then release the allocation when the command is finished.)
• [ ] [sattach](https://slurm.schedmd.com/sattach.html) (Attach to a Slurm job step.)
• [x] [sbatch](https://slurm.schedmd.com/sbatch.html) (Submit a batch script to Slurm.)
• [ ] [sbcast](https://slurm.schedmd.com/sbcast.html) (transmit a file to the nodes allocated to a Slurm job.)
• [x] [scancel](https://slurm.schedmd.com/scancel.html) (Used to signal jobs or job steps that are under the control of Slurm.)
• [x] [scontrol](https://slurm.schedmd.com/scontrol.html) (Used view and modify Slurm configuration and state.)
• [ ] [sdiag](https://slurm.schedmd.com/sdiag.html) (scheduling diagnostic tool.)
• [x] [sinfo](https://slurm.schedmd.com/sinfo.html) (view information about Slurm nodes and partitions.)
• [ ] [slurm](https://slurm.schedmd.com/slurm.html) (Slurm system overview.)
• [ ] [smd](https://slurm.schedmd.com/smd.html) (failure management support tool.)
• [ ] [sprio](https://slurm.schedmd.com/sprio.html) (view the factors that comprise a job's scheduling priority)
• [ ] [sh5util](https://slurm.schedmd.com/sh5util.html) (merge utility for acct_gather_profile plugin.)
• [x] [squeue](https://slurm.schedmd.com/squeue.html) (view information about jobs located in the Slurm scheduling queue.)
• [x] [sreport](https://slurm.schedmd.com/sreport.html) (Generate reports from the slurm accounting data.)
• [x] [srun](https://slurm.schedmd.com/srun.html) (Run parallel jobs)
• [ ] [sshare](https://slurm.schedmd.com/sshare.html) (Tool for listing the shares of associations to a cluster.)
• [x] [sstat](https://slurm.schedmd.com/sstat.html) (Display various status information of a running job/step.)
• [ ] [strigger](https://slurm.schedmd.com/strigger.html) (Used set, get or clear Slurm trigger information.)
• [ ] [sview](https://slurm.schedmd.com/sview.html) (graphical user interface to view and modif. Slurm state.)

Daemons/other:

• [ ] [slurmctld](https://slurm.schedmd.com/slurmctld.html) (The central management daemon of Slurm.)
• [ ] [slurmd](https://slurm.schedmd.com/slurmd.html) (The compute node daemon for Slurm.)
• [ ] [slurmdbd](https://slurm.schedmd.com/slurmdbd.html) (Slurm Database Daemon.)
• [ ] [slurmrestd](https://slurm.schedmd.com/slurmrestd.html) (The Slurm REST API daemon.)
• [ ] [slurmstepd](https://slurm.schedmd.com/slurmstepd.html) (The job step manager for Slurm.)
• [ ] [spank](https://slurm.schedmd.com/spank.html) (Slurm Plug-in Architecture for Node and job (K)control)

[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 :heart: 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 :smile:.
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 though 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 [e-mail] 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
https://github.com/tldr-pages/tldr/issues/2068#issuecomment-753500561,
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!