From 9f942307f531fd5fb24351cc30d0a5d2e9aa3bbc Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Tue, 9 Nov 2010 23:28:38 +0000
Subject: [PATCH] Major update to contribs/README Added descriptions of several
new contributed files/directories
---
contribs/README | 65 +++++++++++++++++++++++++++++++------------------
1 file changed, 41 insertions(+), 24 deletions(-)
diff --git a/contribs/README b/contribs/README
index 9420fd54ff1..7041eb26e7c 100644
--- a/contribs/README
+++ b/contribs/README
@@ -14,10 +14,44 @@ of the SLURM contribs distribution follows:
Build with "make -f /dev/null env_cache_builder" and execute as user root
on the node where the moab daemon runs.
+ lua [ LUA scripts ]
+ Example LUA scripts that can serve as SLURM plugins.
+ job_submit.lua - job_submit plugin that can set a job's default partition
+ using a very simple algorithm
+ proctrack.lua - proctrack (process tracking) plugin that implements a
+ very simple job step container using CPUSETs
+
+ make.slurm.patch [ Patch to "make" command for parallel build ]
+ This patch will use SLURM to launch tasks across a job's current resource
+ allocation. Depending upon the size of modules to be compiled, this may
+ or may not improve performance. If most modules are thousands of lines
+ long, the use of additional resources should more than compensate for the
+ overhead of SLURM's task launch. Use with make's "-j" option within an
+ existing SLURM allocation. Outside of a SLURM allocation, make's behavior
+ will be unchanged. Designed for GNU make-3.81.
+
+ mpich1.slurm.patch [ Patch to mpich1/p4 library for SLURM job task launch ]
+ For SLURM based job initiations (from srun command), get the parameters
+ from environment variables as needed. This allows for a truly parallel
+ job launch using the existing "execer" mode of operation with slight
+ modification.
+
+ pam [ PAM (Pluggable Authentication Module) for SLURM ]
+ This PAM module will restrict who can login to a node to users who have
+ been allocated resources on the node and user root.
+
perlapi/ [ Perl API to SLURM source ]
API to SLURM using perl. Making available all SLURM command that exist
in the SLURM proper API.
+ ptrace.patch [ Linux Kernel patch required to for TotalView use ]
+ 0. This has been fixed on most recent Linux kernels. Older versions of
+ Linux may need this patch support TotalView.
+ 1. gdb and other tools cannot attach to a stopped process. The wait that
+ follows the PTRACE_ATTACH will block indefinitely.
+ 2. It is not possible to use PTRACE_DETACH to leave a process stopped,
+ because ptrace ignores SIGSTOPs sent by the tracing process.
+
sjobexit/ [ Perl programs ]
Tools for managing job exit code records
@@ -36,6 +70,13 @@ of the SLURM contribs distribution follows:
power of two size, then collapse the node list maintaining the numeric
order based upon the Hilbert number.
+ slurmdb-direct [ Perl program ]
+ Program that permits writing directly to SlurmDBD (SLURM DataBase Daemon).
+
+ spank_core.c [ SPANK plugin, C program ]
+ A SLURM SPANK plugin that can be used to permit users to generated
+ light-weight core files rather than full core files.
+
time_login.c [ C program ]
This program will report how long a pseudo-login will take for specific
users or all users on the system. Users identified by this program
@@ -45,27 +86,3 @@ of the SLURM contribs distribution follows:
torque/ [ Wrapper Scripts for Torque migration to SLURM ]
Helpful scripts to make transition to SLURM easier from PBS or Torque.
These scripts are easily updatable if there is functionality missing.
-
- make.slurm.patch [ Patch to "make" command for parallel build ]
- This patch will use SLURM to launch tasks across a job's current resource
- allocation. Depending upon the size of modules to be compiled, this may
- or may not improve performance. If most modules are thousands of lines
- long, the use of additional resources should more than compensate for the
- overhead of SLURM's task launch. Use with make's "-j" option within an
- existing SLURM allocation. Outside of a SLURM allocation, make's behavior
- will be unchanged. Designed for GNU make-3.81.
-
- mpich1.slurm.patch [ Patch to mpich1/p4 library for SLURM job task launch ]
- For SLURM based job initiations (from srun command), get the parameters
- from environment variables as needed. This allows for a truly parallel
- job launch using the existing "execer" mode of operation with slight
- modification.
-
- ptrace.patch [ Linux Kernel patch required to for TotalView use ]
- 0. This has been fixed on most recent Linux kernels. Older versions of
- Linux may need this patch support TotalView.
- 1. gdb and other tools cannot attach to a stopped process. The wait that
- follows the PTRACE_ATTACH will block indefinitely.
- 2. It is not possible to use PTRACE_DETACH to leave a process stopped,
- because ptrace ignores SIGSTOPs sent by the tracing process.
-
--
GitLab