Documentation

NOTE: This documentation is for Slurm version 24.05.
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
• Job Reason Codes
• Job State Codes
• Job Exit Codes
• Resource Binding
• Specific Systems
  • Intel Knights Landing (KNL) User and Administrator Guide

Slurm Administrators

• Quick Start Administrator Guide
• Upgrade Guide
• Accounting
• Advanced Resource Reservation Guide
• Authentication Plugins
• Burst Buffer Guide
• Cgroups Guide
• "Configless" Slurm Operation
• Configuration Tool (Full version)
• Configuration Tool (Simplified version)
• Containers
• CPU Management User and Administrator Guide
• Dynamic Nodes
• Elasticsearch Guide
• Job Completion Kafka plugin Guide
• job_container/tmpfs - Job Specific Temporary File Management
• JSON Web Tokens Authentication
• Federated Scheduling Guide
• Job Containment (SSH Session Control) with pam_slurm_adopt
• Kubernetes Guide
• Large Cluster Administration Guide
• License Management
• Multi-Category Security (MCS) Guide
• Name Service Caching Through NSS Slurm
• Network Configuration Guide
• OpenAPI Plugin Release Notes
• Power Saving Guide (power down idle nodes)
• Prolog and Epilog Guide
• Slurm REST API
  • Quick Start Guide
  • API Reference
  • API Implementation Details
  • Client Guide
• Slurm SELinux Context Management
• 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)
• Cloud
  • Cloud Scheduling Guide
  • Slurm on Google Cloud Platform
  • Deploying Slurm with ParallelCluster on Your AWS Cluster
  • Slurm on Microsoft Azure and CycleCloud

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
  • Command Line Filter Plugin Programmer Guide
  • Job Submission Plugin Programmer Guide
  • PrEp Plugin Programmer Guide
  • Site Factor (Priority) Plugin Programmer Guide

Last modified 22 August 2024