diff --git a/doc/html/accounting.shtml b/doc/html/accounting.shtml index 5ab631d4d05111a36638796a18fff631291036f3..07432446b52fb429b272eccd3202c9169d9ab305 100644 --- a/doc/html/accounting.shtml +++ b/doc/html/accounting.shtml @@ -25,8 +25,9 @@ text file, <a href="http://www.mysql.com/">MySQL</a> or MariaDB database (using the InnoDB storage engine), optionally using SlurmDBD for added security.</li> <li><b>JobAcctGatherType</b> is operating system dependent and controls what mechanism is used to collect accounting information. -Supported values are <i>jobacct_gather/linux</i> -and <i>jobacct_gather/none</i> (no information collected).</li> +Supported values are <i>jobacct_gather/linux</i> (recommended), +<i>jobacct_gather/cgroup<i> and <i>jobacct_gather/none</i> +(no information collected).</li> <li><b>JobCompType</b> controls how job completion information is recorded. This can be used to record basic job information such as job name, user name, allocated nodes, start time, completion diff --git a/doc/html/proctrack_plugins.shtml b/doc/html/proctrack_plugins.shtml index 84b65c653c5c8d9d25f5dd554b11bbac0c5ef0df..abddca80538e580240329691b48e4f8707d6fac0 100644 --- a/doc/html/proctrack_plugins.shtml +++ b/doc/html/proctrack_plugins.shtml @@ -22,7 +22,8 @@ The minor type can be any recognizable abbreviation for the type of proctrack. We recommend, for example:</p> <ul> <li><b>cray</b> — Use Cray job containers.</li> -<li><b>cgroup</b> — Use Linux cgroups for process tracking.</li> +<li><b>cgroup</b> — Use Linux cgroups for process tracking. This is the +recommended mechanism for non CRAY systems. </li> <li><b>linuxproc</b> — Perform process tracking based upon a scan of the Linux process table and use the parent process ID to determine what processes are members of a Slurm job. NOTE: This mechanism is diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index 4ac46647d7be86e0278314988bee0c60b560aee4..05aab2cc16721c8261dd72c220fde303ef92f56b 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -521,7 +521,7 @@ job step credentials. The slurmctld daemon must be restarted for a change in \fBCryptoType\fR to take effect. Acceptable values at present include "crypto/munge" and "crypto/openssl". -The default value is "crypto/munge". +The default value is "crypto/munge" and is the recommended. .TP \fBDebugFlags\fR @@ -987,8 +987,8 @@ The default value is unlimited (zero) and may not exceed 65533 seconds. \fBJobAcctGatherType\fR The job accounting mechanism type. Acceptable values at present include "jobacct_gather/linux" (for Linux -systems), "jobacct_gather/cgroup" and "jobacct_gather/none" -(no accounting data collected). +systems) and is the recommended one, "jobacct_gather/cgroup" and +"jobacct_gather/none" (no accounting data collected). The default value is "jobacct_gather/none". "jobacct_gather/cgroup" is a plugin for the Linux operating system that uses cgroups to collect accounting statistics. The plugin collects the @@ -1076,6 +1076,10 @@ Do not kill process that uses more then requested memory. This parameter should be used with caution as if jobs exceeds its memory allocation it may affect other processes and/or machine health. +NOTE: It is recommended to limit memory by enabling task/cgroup +in TaskPlugin and making use of ConstrainRAMSpace=yes cgroup.conf. +If so, having JobAcctGather as an extra mechanism for memory enforcement +is not recommended, so setting \fBNoOverMemoryKill\fR is advised. .RE .TP @@ -3490,6 +3494,20 @@ Lacks support for the \-\-cpu_bind and/or \-\-mem_bind srun options. The default value is "task/none". .RE +\fBNOTE:\fR It is recommended to stack \fBtask/affinity,task/cgroup\fR together +when configuring TaskPlugin, and setting \fBTaskAffinity=no\fR and +\fBConstrainCores=yes\fR in \fBcgroup.conf\fR. This setup uses the task/affinity +plugin for setting the affinity of the tasks (which is better and different than +task/cgroup) and uses the task/cgroup plugin to fence tasks into the specified +resources, thus combining the best of both pieces. + +\fBNOTE:\fR For CRAY systems only: task/cgroup must be used with, and listed +\fBafter\fR task/cray in TaskPlugin. The task/affinity plugin can be listed +everywhere, but the previous constrain must be satisfied. So for CRAY systems, +a configuration like this is recommended: + +TaskPlugin=task/affinity,task/cray,task/cgroup + .TP \fBTaskPluginParam\fR Optional parameters for the task plugin. @@ -3731,6 +3749,10 @@ session required pam_unix.so For sites configuring PAM with a general configuration file, the appropriate lines (see above), where \fBslurm\fR is the service\-name, should be added. +\fBNOTE\fR: UsePAM option has nothing to do with the +\fBcontribs/pam/pam_slurm\fR and/or \fBcontribs/pam_slurm_adopt\fR modules. So +these two modules can work independently of the value set for UsePAM. + .TP \fBVSizeFactor\fR Memory specifications in job requests apply to real memory size (also known