Welcome to Flux’s documentation!

Flux is a flexible framework for resource management, built for your site. The framework consists of a suite of projects, tools, and libraries which may be used to build site-custom resource managers for High Performance Computing centers.

Contents

• Quick Start
  • Building the Code
  • Starting a Flux Instance
  • Interacting with a Flux Session
  • Flux KVS
  • Launching Work in a Flux Session
• FAQs
  • General Questions
  • MPI Questions
  • Flux Developer Questions
• Debugging Jobs
  • Parallel Debugging using TotalView
  • Better Handling of Flux’s Internal Exec Events
  • Known Issues
• Batch Jobs
  • Launching Flux in Interactive Mode
  • Mini Batch Command
  • Launching Flux in SLURM’s Batch Mode
  • Blocking and Non-blocking Commands
  • Fluxion Scheduler
• Working with Flux Job Hierarchies
  • Instance level (depth)
  • Create a simple test hierarchy
  • Listing Flux instances
  • Listing jobs recursively
  • Flux pstree command
  • Flux top command
  • Connecting to nested jobs
• LLNL Introduction to Flux
• CORAL: Flux launched by IBM LSF
  • Launching Flux
  • Launching Spectrum MPI within Flux
  • Scheduling GPUs
  • Launching Flux Interactively
• CORAL2: Native Flux on Cray Shasta
  • Things to Know
  • Building Flux for CORAL2
• Flux Administrator’s Guide
  • Overview
  • Installation
  • Configuration
  • Flux Accounting
  • Day to day administration
  • Troubleshooting
• Flux Accounting Guide
  • Database Administration
  • Job Usage Factor Calculation
  • Glossary
• Contributing to Flux Development
  • Pull Requests
  • Developer Guidelines
• Flux Python API
• Instrumenting Flux with StatsD
  • Running Brubeck & Graphite
  • Configuring Graphite (Optional)
  • Running Stats Collection in Flux

Contributor Relevant RFCs

• 1/C4.1 - Collective Code Construction Contract

• 2/Flux Licensing and Collaboration Guidelines

• 7/Flux Coding Style Guide

• 9/Distributed Communication and Synchronization Best Practices

All RFCs

• Flux RFC Index

Manual Pages

• flux-core Manual Pages

• flux-sched Manual Pages

• flux-security Manual Pages

Workflow Examples

• Flux Workflow Examples