RFC Index

This is the Flux RFC project.

We collect specifications for APIs, file formats, wire protocols, and processes.

The full RFC specs can be found on readthedocs. Details about each of the active RFC documents can be found in the index

Table of Contents

• 1/C4.1 - Collective Code Construction Contract
• 2/Flux Licensing and Collaboration Guidelines
• 3/Flux Message Protocol
• 4/Flux Resource Model
• 5/Flux Broker Modules
• 6/Flux Remote Procedure Call Protocol
• 7/Flux Coding Style Guide
• 9/Distributed Communication and Synchronization Best Practices
• 10/Content Storage
• 11/Key Value Store Tree Object Format v1
• 12/Flux Security Architecture
• 13/Simple Process Manager Interface v1
• 14/Canonical Job Specification
• 15/Independent Minister of Privilege for Flux: The Security IMP
• 16/KVS Job Schema
• 18/KVS Event Log Format
• 19/Flux Locally Unique ID (FLUID)
• 20/Resource Set Specification
• 21/Job States and Events
• 22/Idset String Representation
• 23/Flux Standard Duration
• 24/Flux Job Standard I/O Version 1
• 25/Job Specification Version 1
• 26/Job Dependency Specification
• 27/Flux Resource Allocation Protocol Version 1
• 28/Flux Resource Acquisition Protocol Version 1
• 29/Hostlist Format
• 30/Job Urgency
• 31/Job Constraints Specification
• 32/Flux Job Execution Protocol Version 1
• 33/Flux Job Queues
• 34/Flux Task Map
• 35/Constraint Query Syntax
• 36/Batch Script Directives
• 37/File Archive Format
• 38/Flux Security Key Value Encoding
• 39/Flux Security Signature
• 40/Fluxion Resource Set Extension
• 41/Job Information Service
• 42/Subprocess Server Protocol
• 43/Job List Service

Build Instructions

To build with python virtual environments:

virtualenv -p python3 sphinx-rtd
source sphinx-rtd/bin/activate
git clone git@github.com:flux-framework/rfc
cd rfc
pip install -r requirements.txt
make html

Change Process

The change process is C4.1 with a few modifications:

• A specification is created and modified by pull requests according to C4.1.
• Each specification has an editor who publishes the RFC to (website TBD) as needed.
• Each specification has a status on that website: Raw, Draft, Stable, Legacy, Retired, Deleted.
• Non-cosmetic changes are allowed only on Raw and Draft specifications.