Documentation

NOTE: This documentation is for Slurm version 20.11.
Documentation for older versions of Slurm are distributed with the source, or may be found in the archive.

Also see Tutorials and Publications and Presentations.

Slurm Users

• Quick Start User Guide
• Command/option Summary (two pages)
• Man Pages
• Rosetta Stone of Workload Managers
• Job Array Support
• Heterogeneous Job Support
• CPU Management User and Administrator Guide
• MPI and UPC Users Guide
• Support for Multi-core/Multi-threaded Architectures
• Multi-Cluster Operation
• Profiling Using HDF5 User Guide
• Failure Management Support
• Job Exit Codes
• Resource Binding
• Specific Systems
  • Cray User and Administrator Guide with Native Slurm
  • Intel Knights Landing (KNL) User and Administrator Guide

Slurm Administrators

• Quick Start Administrator Guide
• Accounting
• Advanced Resource Reservation Guide
• Burst Buffer Guide
• Cgroups Guide
• "Configless" Slurm Operation
• Configuration Tool (Full version)
• Configuration Tool (Simplified version)
• Containers
• CPU Management User and Administrator Guide
• Elasticsearch Guide
• JSON Web Tokens Authentication
• Failure Management Support
• Federated Scheduling Guide
• Job Containment with pam_slurm_adopt
• Large Cluster Administration Guide
• License Management
• Multi-Category Security (MCS) Guide
• Name Service Caching Through NSS Slurm
• Network Configuration Guide
• Power Management Guide (power capping)
• Power Saving Guide (power down idle nodes)
• Prolog and Epilog Guide
• Slurm REST API
• Slurm REST API Reference
• Troubleshooting Guide
• User Permissions
• WCKey Management
• Workload Prioritization
  • Multifactor Job Priority
  • Classic Fairshare Algorithm
  • Depth-Oblivious Fair-share Factor
  • Fair Tree Fairshare Algorithm
• Slurm Scheduling
  • Scheduling Configuration Guide
  • Consumable Resources Guide
  • Core Specialization
  • Gang Scheduling
  • Generic Resource (GRES) Scheduling
  • High Throughput Computing Guide
  • Preemption
  • Quality of Service (QOS)
  • Resource Limits
  • Resource Reservation Guide
  • Sharing Consumable Resources
  • Topology
  • Trackable Resources (TRES)
• Specific Systems
  • Cray User and Administrator Guide with Native Slurm
• Cloud
  • Cloud Scheduling Guide
  • Slurm on Google Cloud Platform
  • Deploying Slurm with ParallelCluster on Your AWS Cluster

Slurm Developers

• Contributor Agreement
• Programmer Guide
• Application Programmer Interface (API) Guide
• Adding Files or Plugins to Slurm
• Design Information
  • Generic Resource (GRES) Design Guide
  • Job Launch Design Guide
  • Select Plugin Design Guide
• Plugin Programmer Guide
• Plugin Interface Details
  • Accounting Storage Plugin Programmer Guide
  • Authentication Plugin Programmer Guide
  • Burst Buffer Plugin Programmer Guide
  • Command Line Program Policy Plugin Programmer Guide
  • Core Specialization Plugin Programmer Guide
  • Credential Plugin Programmer Guide
  • Energy Accounting Plugin Programmer Guide
  • External Sensors Plugin Programmer Guide
  • Generic Resources (GRES) Plugin Programmer Guide
  • Job Accounting Gather Plugin Programmer Guide
  • Job Completion Logging Plugin Programmer Guide
  • Job Container Plugin API
  • Job Submission Plugin Programmer Guide
  • Launch Plugin Programmer Guide
  • MPI Plugin Programmer Guide
  • Multi-Category Security (MCS) Plugin Programmer Guide
  • Node Features Plugin Programmer Guide
  • Power Management Plugin Programmer Guide
  • Preemption Plugin Programmer Guide
  • PrEp Plugin Programmer Guide
  • Priority Plugin Programmer Guide
  • Process Tracking Plugin Programmer Guide
  • Profile Accounting Plugin Programmer Guide
  • Resource Selection Plugin Programmer Guide
  • Scheduler Plugin Programmer Guide
  • Site Factor (Priority) Plugin Programmer Guide
  • Slurmctld Generic Plugin Programmer Guide
  • Switch (Interconnect) Plugin Programmer Guide
  • Task Plugin Programmer Guide
  • Topology Plugin Programmer Guide

Last modified 21 October 2020