diff --git a/doc/html/Makefile.am b/doc/html/Makefile.am index 94951e66d4fb98090347edbdcf25ffd982aeb491..5e13a9ca4dce77d708273494ac439ce7a35f2b5d 100644 --- a/doc/html/Makefile.am +++ b/doc/html/Makefile.am @@ -40,6 +40,7 @@ generated_html = \ quickstart_admin.html \ quickstart.html \ reservations.html \ + resource_limits.html \ schedplugins.html \ selectplugins.html \ slurm.html \ diff --git a/doc/html/Makefile.in b/doc/html/Makefile.in index e3e91b2151bf54049d88b7218e4bb8c9a04bfa1e..91caeaeab14c7d88ce80ab615bd13d17f247fdf5 100644 --- a/doc/html/Makefile.in +++ b/doc/html/Makefile.in @@ -289,6 +289,7 @@ generated_html = \ quickstart_admin.html \ quickstart.html \ reservations.html \ + resource_limits.html \ schedplugins.html \ selectplugins.html \ slurm.html \ diff --git a/doc/html/cray.shtml b/doc/html/cray.shtml index 93da1a9e501c3df46fdf60eaf20e1e3d9fcdf4b9..0d92a64b4ae903590b6b4c981bd1099e60beab46 100644 --- a/doc/html/cray.shtml +++ b/doc/html/cray.shtml @@ -2,8 +2,7 @@ <h1>SLURM User and Administrator Guide for Cray systems</h1> -<b>NOTE: As of January 2009, the SLURM interface to Cray systems is still -under development.</b> +<b>NOTE: As of January 2009, the SLURM interface to Cray systems is incomplete.</b> <h2>User Guide</h2> diff --git a/doc/html/documentation.shtml b/doc/html/documentation.shtml index ad65010a618d56fcadf52e0c7d025a09c99f01ab..fdba4f33f68e7adef5655b4e30395620897aee9f 100644 --- a/doc/html/documentation.shtml +++ b/doc/html/documentation.shtml @@ -9,10 +9,13 @@ Also see <a href="publications.html">Publications and Presentations</a>. <li><a href="quickstart.shtml">Quick Start User Guide</a></li> <li><a href="mc_support.shtml">Support for Multi-core/Multi-threaded Architectures</a></li> <li><a href="quickstart.shtml#mpi">Guide to MPI Use</a></li> +<li>Specific Systems</li> +<ul> <li><a href="bluegene.shtml">Blue Gene User and Administrator Guide</a></li> <li><a href="cray.shtml">Cray User and Administrator Guide</a></li> <li><a href="ibm.shtml">IBM AIX User and Administrator Guide</a></li> </ul> +</ul> <h2>SLURM Administrators</h2> <ul> @@ -20,21 +23,31 @@ Also see <a href="publications.html">Publications and Presentations</a>. <li><a href="configurator.html">Configuration Tool</a></li> <li><a href="troubleshoot.shtml">Troubleshooting Guide</a></li> <li><a href="big_sys.shtml">Large Cluster Administration Guide</a></li> -<li><a href="cons_res.shtml">Consumable Resources Guide</a></li> -<li><a href="cons_res_share.shtml">Sharing Consumable Resources</a></li> <li><a href="accounting.shtml">Accounting</a></li> +<li><a href="power_save.shtml">Power Saving Guide</a></li> +<li>SLURM Scheduling</li> +<ul> +<li><a href="cons_res.shtml">Consumable Resources Guide</a></li> <li><a href="gang_scheduling.shtml">Gang Scheduling</a></li> <li><a href="job_priority.shtml">Job Priority</a></li> <li><a href="preempt.shtml">Preemption</a></li> +<li><a href="resource_limits.shtml">Resource Limits</a></li> +<li><a href="reservations.shtml">Resource Reservation Gude</a></li> +<li><a href="cons_res_share.shtml">Sharing Consumable Resources</a></li> +</ul> +<li>External Schedulers</li> +<ul> <li><a href="maui.shtml">Maui Scheduler Integration Guide</a></li> <li><a href="moab.shtml">Moab Cluster Suite Integration Guide</a></li> <li><a href="http://docs.hp.com/en/5991-4847/ch09s02.html">Submitting Jobs through LSF</a></li> +</ul> +<li>Specific Systems</li> +<ul> <li><a href="bluegene.shtml">Blue Gene User and Administrator Guide</a></li> <li><a href="cray.shtml">Cray User and Administrator Guide</a></li> -<li><a href="sun_const.shtml">Sun Constellation Aministrator Guide</a></li> <li><a href="ibm.shtml">IBM AIX User and Administrator Guide</a></li> -<li><a href="power_save.shtml">Power Saving Guide</a></li> -<li><a href="reservations.shtml">Resource Reservation Gude</a></li> +<li><a href="sun_const.shtml">Sun Constellation Aministrator Guide</a></li> +</ul> </ul> <h2>SLURM Developers</h2> @@ -42,6 +55,8 @@ Also see <a href="publications.html">Publications and Presentations</a>. <li><a href="programmer_guide.shtml">Programmer Guide</a></li> <li><a href="api.shtml">Application Programmer Interface (API) Guide</a></li> <li><a href="plugins.shtml">Plugin Programmer Guide</a></li> +<li>Plugin Interface Details</li> +<ul> <li><a href="authplugins.shtml">Authentication Plugin Programmer Guide</a></li> <li><a href="crypto_plugins.shtml">Cryptographic Plugin Programmer Guild</a></li> <li><a href="jobacct_gatherplugins.shtml">Job Accounting Gather Plugin Programmer Guide</a></li> @@ -54,8 +69,9 @@ Also see <a href="publications.html">Publications and Presentations</a>. <li><a href="selectplugins.shtml">Resource Selection Plugin Programmer Guide</a></li> <li><a href="switchplugins.shtml">Switch (Interconnect) Plugin Programmer Guide</a></li> <li><a href="taskplugins.shtml">Task Plugin Programmer Guide</a></li> +</li> </ul> -<p style="text-align:center;">Last modified 6 February 2009</p> +<p style="text-align:center;">Last modified 9 February 2009</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/overview.shtml b/doc/html/overview.shtml index 6e857e76c21238e9f0d00dbc22d96804676ba9a9..4fc48e23d0995d2c1563f694de1c8a5333281c69 100644 --- a/doc/html/overview.shtml +++ b/doc/html/overview.shtml @@ -1,6 +1,7 @@ <!--#include virtual="header.txt"--> <h1><a name="top">Overview</a></h1> + <p>The Simple Linux Utility for Resource Management (SLURM) is an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters. SLURM requires no kernel modifications for @@ -8,8 +9,18 @@ its operation and is relatively self-contained. As a cluster resource manager, SLURM has three key functions. First, it allocates exclusive and/or non-exclusive access to resources (compute nodes) to users for some duration of time so they can perform work. Second, it provides a framework for starting, executing, and -monitoring work (normally a parallel job) on the set of allocated nodes. Finally, -it arbitrates contention for resources by managing a queue of pending work.</p> +monitoring work (normally a parallel job) on the set of allocated nodes. +Finally, it arbitrates contention for resources by managing a queue of +pending work. +Optional plugins can be used for +<a href="accounting.html">accounting</a>, +<a href="reservations.html">advanced reservation</a>, +<a href="gang_scheduling.html">gang scheduling</a> (time sharing for +parallel jobs), backfill scheduling, +<a href="resource_limits.html">resource limits</a> by user or bank account, +and sophisticated <a href="job_priority.html">job prioritization</a> +algorithms. + <p>SLURM has been developed through the collaborative efforts of <a href="https://www.llnl.gov/">Lawrence Livermore National Laboratory (LLNL)</a>, @@ -87,7 +98,9 @@ The Maui Scheduler</a>, and Moab Cluster Suite</a>. There is also a <a href="job_priority.html">job prioritization</a> plugin available for use with the FIFO, backfil and gang schedulers. Jobs can be -prioritized by age, size, fair-share allocation, etc.</li> +prioritized by age, size, fair-share allocation, etc. +Many <a href="resource_limits.html">resource limits</a> are also +configurable by user or bank account.</li> <li><a href="switchplugins.html">Switch or interconnect</a>: <a href="http://www.quadrics.com/">Quadrics</a> diff --git a/doc/html/quickstart_admin.shtml b/doc/html/quickstart_admin.shtml index ce80c8084bcfb0b98be8a4779feed51c521f7b58..ce363f11ce197c35d0215a3e728cf499c947bc10 100644 --- a/doc/html/quickstart_admin.shtml +++ b/doc/html/quickstart_admin.shtml @@ -221,30 +221,46 @@ do have this requirement.</p> For more information, see <a href="quickstart.html#mpi">MPI</a>. <h3>Scheduler support</h3> -<p>The scheduler used by SLURM is controlled by the <b>SchedType</b> configuration -parameter. This is meant to control the relative importance of pending jobs and -several options are available -SLURM's default scheduler is <u>FIFO (First-In First-Out)</u>. -SLURM offers a backfill scheduling plugin. -<u>Backfill scheduling</u> will initiate a lower-priority jobs -if doing so does not delay the expected initiation time of higher priority jobs; -essentially using smaller jobs to fill holes in the resource allocation plan. -Effective backfill scheduling does require users to specify job time limits. -SLURM offers a <u>gang scheduler</u>, which time-slices jobs in the same partition/queue -and can be used to preempt jobs from lower-priority queues in order to execute -jobs in higher priority queues. -SLURM also supports a plugin for use of +<p>SLURM can be configured with rather simple or quite sophisticated +scheduling algorithms depending upon your needs and willingness to +manage the configuration (much of which requires a database). +The first configuration parameter of interest is <b>PriorityType</b> +with two options available: <i>basic</i> (first-in-first-out) and +<i>multifactor</i>. +The <i>multifactor</i> plugin is very configurable and its details +are beyond the scope of this document. +See the <a href="job_priority.html">Multi-factor Job Priority Plugin</a> +document for details.</p> + +<p>The <b>SchedType</b> configuration parameter controls how queued +jobs are scheduled and several options are available. +<ul> +<li><i>builtin</i> will initiate jobs strictly in their priority order, +typically (first-in-first-out) </li> +<li><i>backfill</i> will initiate a lower-priority job if doing so does +not delay the expected initiation time of higher priority jobs; essentially +using smaller jobs to fill holes in the resource allocation plan. Effective +backfill scheduling does require users to specify job time limits.</li> +<li><i>gang</i> time-slices jobs in the same partition/queue and can be +used to preempt jobs from lower-priority queues in order to execute +jobs in higher priority queues.</li> +<li><i>wiki</i> is an interface for use with <a href="http://www.clusterresources.com/pages/products/maui-cluster-scheduler.php"> -The Maui Scheduler</a> or +The Maui Scheduler</a></li> +<li><i>wiki2</i> is an interface for use with the <a href="http://www.clusterresources.com/pages/products/moab-cluster-suite.php"> -Moab Cluster Suite</a> which offer sophisticated scheduling algorithms. -For more information about these options see +Moab Cluster Suite</a> +</ul> + +<p>For more information about scheduling options see <a href="gang_scheduling.html">Gang Scheduling</a>, -<a href="preempt.html">Preemption</a> and +<a href="preempt.html">Preemption</a>, +<a href="reservations.html">Resource Reservation Guide</a>, +<a href="resource_limits.html">Resource Limits</a> and <a href="cons_res_share.html">Sharing Consumable Resources</a>.</p> -<h3>Node selection</h3> -<p>The node selection mechanism used by SLURM is controlled by the +<h3>Resource selection</h3> +<p>The resource selection mechanism used by SLURM is controlled by the <b>SelectType</b> configuration parameter. If you want to execute multiple jobs per node, but apportion the processors, memory and other resources, the <i>cons_res</i> (consumable resources) diff --git a/doc/html/reservations.shtml b/doc/html/reservations.shtml index e7fb12ec658db798d4764212d832da58b8acbc9a..6cf9bc91905831e6b125819810ff852b1d90cc3b 100644 --- a/doc/html/reservations.shtml +++ b/doc/html/reservations.shtml @@ -2,7 +2,7 @@ <h1>Resource Reservation Gude</h1> -<p>SLURM verstion 1.4 has the ability to reserve resources for jobs +<p>SLURM verstion 2.0 has the ability to reserve resources for jobs being executed by select users and/or select bank accounts. A resource reservation identifies the nodes of a resource reservation and a time period during which the reservation is available.</p> diff --git a/doc/html/sched_policy.shtml b/doc/html/resource_limits.shtml similarity index 96% rename from doc/html/sched_policy.shtml rename to doc/html/resource_limits.shtml index 53aed3fd9dd91bfcad87b8ec11bfb1bb76c319a4..d6c9fe5834b970a24c73e4ceef33d943f605e274 100644 --- a/doc/html/sched_policy.shtml +++ b/doc/html/resource_limits.shtml @@ -1,12 +1,12 @@ <!--#include virtual="header.txt"--> -<h1>Sheduling Policy</h1> +<h1>Resource Limits</h1> <p>SLURM scheduling policy support was significantly changed -in version 1.3 in order to take advantage of the database +in version 2.0 in order to take advantage of the database integration used for storing accounting information. This document describes the capabilities available in -SLURM version 1.3.4. +SLURM version 2.0. New features are under active development. Familiarity with SLURM's <a href="accounting">Accounting</a> web page is strongly recommended before use of this document.</p> @@ -111,6 +111,6 @@ The time window considered in fair-share scheduling will be configurable as well as the relative importance of job age (time waiting to run), but this this example illustrates the concepts involved.</p> -<p style="text-align: center;">Last modified 24 June 2008</p> +<p style="text-align: center;">Last modified 9 February 2009</p> </ul></body></html> diff --git a/doc/html/slurm.shtml b/doc/html/slurm.shtml index 59704a034ea2d5c5a40829dbb5e0c637ea6e6bb4..3491911d3cc9293c0f940a2b279ecc64f2b6712c 100644 --- a/doc/html/slurm.shtml +++ b/doc/html/slurm.shtml @@ -18,7 +18,7 @@ couple of minutes (see <a href="http://www.linux-mag.com/id/7239/1/"> Caos NSA and Perceus: All-in-one Cluster Software Stack</a> by Jeffrey B. Layton). More complex configurations rely upon a -<a href="http://www.mysql.com/">MySQL</a> for archiving +<a href="http://www.mysql.com/">MySQL</a> database for archiving <a href="accounting.html">accounting</a> records, managing <a href="resource_limits.html">resource limits</a> by user or bank account, or supporting sophisticated <a href="job_priority.html">job prioritization</a>