Flux Framework Documentation

_images/logo.png

Flux is a resource manager for high-performance computing that schedules jobs across HPC clusters, cloud resources, and containers. Unlike traditional resource managers, Flux doesn’t require administrator privileges—launch it within other resource managers or Flux itself, on your laptop, or deploy it as your site’s primary scheduler.

This means you get a full-featured resource manager for complex workflows, ensemble runs, or testing without waiting for sysadmin support. Schedule 10,000-node MPI jobs, run millions of tasks, or dynamically manage resources within a single batch job.

Compare Flux to Slurm/PBS/LSF | Get Started

Getting Started

Manual Pages

Command and API references: Manual Pages (job commands) | flux-sched Manual Pages (scheduling) | Manual Pages (security tools)

Installing Flux

Start with flux-core (install guide) for job execution, commands, APIs, and built-in schedulers.

For advanced scheduling, add flux-sched (install guide) to enable the fluxion scheduler with graph-based resource matching.

For multi-user installations, flux-security is required for authentication. flux-accounting provides resource accounting and priority management.

Flux Projects

Complete documentation for the core Flux projects:

flux-core

Core resource manager with simple schedulers, job execution, commands, and APIs

https://flux-framework.readthedocs.io/projects/flux-core/en/latest/
flux-sched

Fluxion scheduler with graph-based scheduling and resource matching

https://flux-framework.readthedocs.io/projects/flux-sched/en/latest/
flux-accounting

Multi-user resource accounting and priority management

https://flux-framework.readthedocs.io/projects/flux-accounting/en/latest/
flux-security

Security framework for multi-user support with job signing and the IMP setuid helper

https://flux-framework.readthedocs.io/projects/flux-security/en/latest/

See also: flux-pmix, flux-coral2, dyad, and other projects

FAQs | Tutorials | Comics 🎨 | Flux Website

Technical: RFCs | Contributing