Documentation
NOTE: This documentation is for Slurm version 16.05.
Documentation for other versions of Slurm is distributed with the code
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
- 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
- Slurm Checkpoint/Restart with BLCR
- Job Exit Codes
- Specific Systems
Slurm Administrators
- Quick Start Administrator Guide
- Accounting
- Advanced Resource Reservation Guide
- Burst Buffer Guide
- Cgroups Guide
- Configuration Tool (Full version)
- Configuration Tool (Simplified version)
- CPU Management User and Administrator Guide
- Failure Management Support
- Large Cluster Administration Guide
- License Management
- Multi-Category Security (MCS) Guide
- Power Management Guide (power capping)
- Power Saving Guide (power down idle nodes)
- Prolog and Epilog Guide
- Troubleshooting Guide
- User Permissions
- WCKey Management
- Workload Prioritization
- Slurm Scheduling
- Scheduling Configuration Guide
- Consumable Resources Guide
- Core Specialization
- Elastic Computing
- 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)
- External Schedulers
- Specific Systems
Slurm Developers
- Contributor Agreement
- Programmer Guide
- Application Programmer Interface (API) Guide
- Remote Procedure Call (RPC) Update Guide
- Adding Files or Plugins to Slurm
- Design Information
- Plugin Programmer Guide
- Plugin Interface Details
- Accounting Storage Plugin Programmer Guide
- Authentication Plugin Programmer Guide
- Burst Buffer Plugin Programmer Guide
- Core Specialization Plugin Programmer Guide
- Cryptographic 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 Checkpoint 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
- Priority Plugin Programmer Guide
- Process Tracking Plugin Programmer Guide
- Profile Accounting Plugin Programmer Guide
- Resource Selection Plugin Programmer Guide
- Scheduler Plugin Programmer Guide
- Slurmctld Generic Plugin Programmer Guide
- Switch (Interconnect) Plugin Programmer Guide
- Task Plugin Programmer Guide
- Topology Plugin Programmer Guide
Last modified 11 February 2016