From dd737d6c66c39486cd7b14757c3721ad9d352874 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Wed, 29 Nov 2006 19:54:59 +0000
Subject: [PATCH] Update documenation for Maui Scheduler.
---
RELEASE_NOTES | 19 +++++++++----
doc/html/maui.shtml | 60 +++++++++++++++++++++++++++++++++-------
doc/html/moab.shtml | 4 +--
doc/man/man5/wiki.conf.5 | 16 +++++++----
4 files changed, 77 insertions(+), 22 deletions(-)
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
index 6e9700c72cf..34527718f36 100644
--- a/RELEASE_NOTES
+++ b/RELEASE_NOTES
@@ -74,18 +74,27 @@ OTHER CHANGES
* There is a new version of the Wiki scheduler plugin to interface with
the Moab Scheduler. It can be accessed with the slurm.conf parameter
"SchedulerType=sched/wiki2". Continue using "SchedulerType=sched/wiki"
- for the Maui Scheduler at this time. Some time in early 2007 the Maui
- Scheduler should be upgraded to use the additional capabilities
- offered by sched/wiki2. If you use sched/wiki2, you will at least
- need to add a wiki.conf file. Key differences include:
+ for the Maui Scheduler at this time and see the section below for details.
+ If you use sched/wiki2, you will at least need to add a wiki.conf file.
+ Key differences include:
- Node and job data returned is correct (several errors in old plugin)
- Node data includes partition information (CCLASS field)
- Improved error handling
- Support added for configuration file ("wiki.conf" in same directory
as "slurm.conf" file, see "man wiki.conf" for details)
- - Support added for job suspend/resume and requeue
+ - Support added for job modify, suspend/resume, and requeue
- Authentication of communications now supported
- Notification of scheduler on events (job submitted or termination)
- There is no longer a "sched-wiki" RPM. All files are in the main RPM.
+* The sched/wiki plugin has been re-written for use with the Maui Scheduler.
+ Some time in early 2007 the Maui Scheduler should be upgraded to use
+ the additional capabilities offered by sched/wiki2. Changes in sched/wiki
+ include:
+ - Node and job data returned is correct (several errors in old plugin)
+ - Support added for configuration file ("wiki.conf" in same directory
+ as "slurm.conf" file, see "man wiki.conf" for details). Currntly
+ wiki.conf is only used to store an authentication key.
+ - There is no longer a "sched-wiki" RPM. All files are in the main RPM.
+
See the file NEWS for more details.
diff --git a/doc/html/maui.shtml b/doc/html/maui.shtml
index bf00627b86f..28f21e9cf49 100644
--- a/doc/html/maui.shtml
+++ b/doc/html/maui.shtml
@@ -14,8 +14,15 @@ http://www.clusterresources.com/products/maui/docs/mauiadmin.shtml</a>.
<a href="http://www.clusterresources.com/pages/products/maui-cluster-scheduler.php">
http://www.clusterresources.com/pages/products/maui-cluster-scheduler.php</a>.
Note: maui-3.2.6p9 has been validated with SLURM, other versions
-should also work properly.</p>
+should also work properly.
+We anticipate the Maui Scheduler to be upgraded to utilize a more
+extensive interface to Slurm in early 2007.
+The newer Maui Scheduler will be able to utilize a more ful featured
+interface to Slurm as descripted in the
+<a href="moab.html">Moab Cluster Suite Integration Guide</a>.
+This guide will be upgrade at that time.</p>
+<h3>Maui configuration</h3>
<p>Make sure that SLURM is installed and running before building Maui.
Then build Maui from its source distribution. This is a two step process:
<ol>
@@ -44,7 +51,8 @@ is available and accessible. You can also set a polling interval with
<pre>
RMPOLLINTERVAL 00:00:20
</pre>
-I like Maui to poll SLURM quite often -- in this case every 20 seconds.
+It may be desired to have Maui poll SLURM quite often --
+in this case every 20 seconds.
Note that a job submitted to an idle cluster will not be initiated until
the Maui daemon polls SLURM and decides to make it run, so the value of
RMPOLLINTERVAL should be set to a value appropriate for your site
@@ -67,26 +75,58 @@ NODECFG[linux2] PARTITION=PartA
NODECFG[linux3] PARTITION=PartA
</pre>
-<p>
-Set the slurm.conf scheduler parameters as follows:
+<p>Set the following environment variables and path:
+<pre>
+set path=(/root/MAUI/maui-3.2.6p9/bin $path)
+setenv MAUIHOMEDIR /root/MAUI/maui-3.2.6p9
+</pre>
+
+<p class="footer"><a href="#top">top</a></p>
+
+<h3>SLURM configuration</h3>
+<p>Set the slurm.conf scheduler parameters as follows:
<pre>
SchedulerType=sched/wiki
SchedulerPort=7321
-SchedulerAuth=42
+SchedulerAuth=42 (for Slurm version 1.1 and earlier only)
</pre>
In this case, "SchedulerAuth" has been set to 42, which was the key
specified when Maui was configured above. Just make sure the numbers match.
-The Maui folks have assured me that the key won't always be a compiled-in
+The Maui folks have assured us that the key won't always be a compiled-in
feature.</p>
-<p>Set the following environment variables and path:
+<p>For Slurm version 1.2 or higher, the authentication key
+is stored in a file specific to the wiki-plugin named
+<i>wiki.conf</i>.
+This file should be protected from reading by users.
+It only needs to be readable by <i>SlurmUser</i> (as configured
+in <i>slurm.conf</i>) and only needs to exist on computers
+where the <i>slurmctld</i> daemon executes.
+More information about wiki.conf is available in
+a man page distributed with SLURM, although that
+includes a description of keywords presently only
+supported by the sched/wiki2 plugin for use with the
+Moab Scheduler.</p>
+
+<p>They only wiki.conf keyword used by the sched/wiki plugin
+is <b>AuthKey</b>, which should match the key used to configure
+Maui at build time.
+Note that SLURM's wiki plugin does not include a mechanism
+to submit new jobs, so even without this key nobody could
+run jobs as another user.</p>
+
+<p>Here is a sample <i>wiki.conf</i> file
<pre>
-set path=(/root/MAUI/maui-3.2.6p9/bin $path)
-setenv MAUIHOMEDIR /root/MAUI/maui-3.2.6p9
+# wiki.conf
+# SLURM's wiki plugin configuration file
+#
+# Matches KEY in moab-private.cfg
+AuthKey=1234
</pre>
+</p>
<p class="footer"><a href="#top">top</a></p>
-<p style="text-align:center;">Last modified 24 August 2006</p>
+<p style="text-align:center;">Last modified 29 November 2006</p>
<!--#include virtual="footer.txt"-->
diff --git a/doc/html/moab.shtml b/doc/html/moab.shtml
index fd01b64d3c5..b7af55a3473 100644
--- a/doc/html/moab.shtml
+++ b/doc/html/moab.shtml
@@ -18,7 +18,7 @@ Note: Moab version 4.5.0 or higher and SLURM version 1.1.10 or higher.</p>
<h3>SLURM configuration</h3>
<p>Set the <i>slurm.conf</i> scheduler parameters as follows:
<pre>
-SchedulerType=sched/wiki2 (NOTE: "sched/wiki" in slurm version 1.2)
+SchedulerType=sched/wiki2
SchedulerPort=7321
</pre>
Running multiple jobs per mode can be accomplished using the
@@ -111,6 +111,6 @@ KEY=1234
<p class="footer"><a href="#top">top</a></p>
-<p style="text-align:center;">Last modified 29 September 2006</p>
+<p style="text-align:center;">Last modified 29 November 2006</p>
<!--#include virtual="footer.txt"-->
diff --git a/doc/man/man5/wiki.conf.5 b/doc/man/man5/wiki.conf.5
index 8c311088f38..f3de63d5f53 100644
--- a/doc/man/man5/wiki.conf.5
+++ b/doc/man/man5/wiki.conf.5
@@ -1,9 +1,9 @@
-.TH "wiki.conf" "5" "October 2006" "wiki.conf 1.1" "Slurm configuration file"
+.TH "wiki.conf" "5" "November 2006" "wiki.conf 1.2" "Slurm configuration file"
.SH "NAME"
-wiki.conf \- Slurm configuration file for wiki scheduler plugin
+wiki.conf \- Slurm configuration file for wiki and wiki2 scheduler plugins
.SH "DESCRIPTION"
-\fB/etc/wiki.conf\fP is an ASCII file which describes wiki scheduler
-specific SLURM configuration information.
+\fB/etc/wiki.conf\fP is an ASCII file which describes wiki and wiki2
+scheduler specific SLURM configuration information.
.LP
Paramter names are case insensitive.
Any text following a "#" in the configuration file is treated
@@ -19,7 +19,8 @@ The overall configuration parameters available include:
\fBAuthKey\fR
Authentication key for communications.
This numeric value should match KEY configured in the
-\fBmoab\-private.cnf\fR file.
+\fBmoab\-private.cnf\fR file (for the Moab Scheduler) or the
+\fB--with-key=\fR value used to configure the Maui Scheduler.
.TP
\fBEHost\fR
@@ -27,6 +28,7 @@ Name the computer on which Moab server executes.
It is used in establishing a communications path for event notification.
By default \fBEHost\fR will be identical in value to the
\fBControlAddr\fR configured in slurm.conf.
+Not applicable to wiki plugin, only the wiki2 plugin.
.TP
\fBEHostBackup\fR
@@ -34,6 +36,7 @@ Name the computer on which the backup Moab server executes.
It is used in establishing a communications path for event notification.
By default \fBEHostBackup\fR will be identical in value to the
\fBBackupAddr\fR configured in slurm.conf.
+Not applicable to wiki plugin, only the wiki2 plugin.
.TP
\fBEPort\fR
@@ -41,6 +44,7 @@ Port to be used to notify Moab of events (job submitted to Slurm,
job terminates, etc.).
This numeric value should match EPORT configured in the
\fBmoab.cnf\fR file.
+Not applicable to wiki plugin, only the wiki2 plugin.
.TP
\fBJobAggregationTime\fR
@@ -52,11 +56,13 @@ This should be an integer number of seconds.
The default value is 10 seconds.
The value should match JOBAGGREGATIONTIME configured in the
\fBmoab.cnf\fR file.
+Not applicable to wiki plugin, only the wiki2 plugin.
.TP
\fBJobPriority\fR
Controls initial job priority.
Default value is "hold".
+Not applicable to wiki plugin, only the wiki2 plugin.
.RS
.TP
\fBrun\fR: Job permitted to run directly under SLURM's control
--
GitLab