Ticket 16832 - Group limit GrpCPUs needs to be documented
Summary: Group limit GrpCPUs needs to be documented
Status: RESOLVED FIXED
Alias: None
Product: Slurm
Classification: Unclassified
Component: Documentation (show other tickets)
Version: 22.05.8
Hardware: Linux Linux
: --- 4 - Minor Issue
Assignee: Oscar Hernández
QA Contact: Ben Roberts
URL:
Depends on:
Blocks:
 
Reported: 2023-05-26 01:00 MDT by Ole.H.Nielsen@fysik.dtu.dk
Modified: 2023-06-28 09:44 MDT (History)
1 user (show)

See Also:
Site: DTU Physics
Alineos Sites: ---
Atos/Eviden Sites: ---
Confidential Site: ---
Coreweave sites: ---
Cray Sites: ---
DS9 clusters: ---
HPCnow Sites: ---
HPE Sites: ---
IBM Sites: ---
NOAA SIte: ---
OCF Sites: ---
Recursion Pharma Sites: ---
SFW Sites: ---
SNIC sites: ---
Linux Distro: ---
Machine Name:
CLE Version:
Version Fixed: 23.02.3 23.11.0rc1
Target Release: ---
DevPrio: ---
Emory-Cloud Sites: ---


Attachments

Note You need to log in before you can comment on or make changes to this ticket.
Description Ole.H.Nielsen@fysik.dtu.dk 2023-05-26 01:00:04 MDT
The sacctmgr manual page defines a number of group limits (GrpJobs, GrpTRES, etc.).  However, it seems that there exists an undocumented limit GrpCPUs which is only mentioned without specifications in the QOS manual page.

Can you please document GrpCPUs in the sacctmgr manual page?

Thanks,
Ole
Comment 2 Oscar Hernández 2023-05-26 08:47:53 MDT
Hi Ole,

Although you are right and we are still accepting GrpCPUs in sacctmgr:

>sacctmgr modify account acct cluster=cls set GrpCPUs=3
> Modified account associations...
>  C = cls        A = acct of root
It is just supported for legacy compatibility. New way of setting this limit should be via GrpTRES[1]. With this being equivalent to the previous limit:

>sacctmgr modify account acct cluster=cls set GrpTRES=cpu=3
> Modified account associations...
>  C = cls        A = acct of root
This is the reason it is not currently documented in sacctmgr man page - we do not want to promote the use of deprecated concepts - which could cause confusion now.

Cheers,
Oscar

[1]https://slurm.schedmd.com/sacctmgr.html#OPT_GrpTRES_2
Comment 3 Ole.H.Nielsen@fysik.dtu.dk 2023-05-30 00:22:44 MDT
Hi Oscar,

(In reply to Oscar Hernández from comment #2)
> Although you are right and we are still accepting GrpCPUs in sacctmgr:
> 
> >sacctmgr modify account acct cluster=cls set GrpCPUs=3
> > Modified account associations...
> >  C = cls        A = acct of root
> It is just supported for legacy compatibility. New way of setting this limit
> should be via GrpTRES[1]. With this being equivalent to the previous limit:

Thanks for the info.  This parameter came up in a discussion on the slurm-users list, and I was trying to find its documentation and could only find it in the QOS[1] page.

Could you kindly update or delete this section in the QOS[1] manual:

> Set some other limits
> 
> $ sacctmgr modify qos zebra set GrpCPUs=24
>  Modified qos...
>   zebra
> 
> $ sacctmgr show qos format=name,priority,GrpCPUs
>       Name   Priority  GrpCPUs
> ---------- ---------- --------
>     normal          0
>      zebra         10       24

It may make sense to refer to GrpTRES=cpu=24 in stead.

Thanks,
Ole

[1] https://slurm.schedmd.com/qos.html
Comment 13 Oscar Hernández 2023-06-14 02:06:44 MDT
Hi Ole,

Apologies for the delay on getting back to you. Your request had all the sense, so we took the opportunity to improve some other documentation like sacctmgr man page.

This changes are now pushed, and will be available on the web when next release is out, which should be soon. Here the commits:

commit 8bf3ee777f74e05231af759582e1685c8275f244
Author: Ben Roberts <ben@schedmd.com>
Date:   Wed Jun 7 14:12:31 2023 -0500

    Docs - Enumerate TRES types for Grp/MaxTRES
    
    Bug 16832
    
    Signed-off-by: Oscar Hernández <oscar.hernandez@schedmd.com>

commit 78d4a01329d965cc8d2aa97f331b8766804a1e1e
Author: Oscar Hernández <oscar.hernandez@schedmd.com>
Date:   Thu Jun 8 17:17:06 2023 +0200

    Docs - Deprecate GrpNodes option in sacctmgr man page
    
    Bug 16832

commit 1b4a90996f3174ba0aec9767fb2af22bf2a16656
Author: Oscar Hernández <oscar.hernandez@schedmd.com>
Date:   Tue May 30 10:51:07 2023 +0200

    Docs - Update QOS modification example in qos.html for GrpTRES
    
    Bug 16832

I am leaving this bug open since we may potentially add another change. Will close as soon as it is resolved.

As always, thanks for the feedback.

Oscar
Comment 14 Ole.H.Nielsen@fysik.dtu.dk 2023-06-14 02:12:03 MDT
Hi Oscar,

(In reply to Oscar Hernández from comment #13)
> Apologies for the delay on getting back to you. Your request had all the
> sense, so we took the opportunity to improve some other documentation like
> sacctmgr man page.
> 
> This changes are now pushed, and will be available on the web when next
> release is out, which should be soon. Here the commits:
...
> I am leaving this bug open since we may potentially add another change. Will
> close as soon as it is resolved.
> 
> As always, thanks for the feedback.


Thanks a lot for the documentation updates!

Ole