Welcome to OAR3’s documentation!

Warning

THIS DOCUMENTATION IS UNDER CONSTRUCTION (NOT READY FOR PRODUCTION USE)

OAR: Versatile Resource and Job Manager

OAR is a versatile resource and job manager (also called a batch scheduler or job scheduler) for HPC clusters and other computing infrastructures (like distributed computing experimental testbeds where versatility is a key). This is the third generation.

• Free software: GPL-2.1 license.

• Documentation: https://oar-3.readthedocs.org.

• General Information: http://oar.imag.fr/oar_3.

This documentation is organized into a few different sections below:

• User Documentation

• Admin Documentation

• Developer Documentation

• Changelog

• Copyright and license

User Documentation

• Using OAR - Basic steps
• OAR Use Cases
• Mechanisms
• User Commands
• User REST API
• FAQ - USER

Admin Documentation

• Installation
• Configuration file
• Admission Rules
• Scheduling
• Admin Commands
• Admin REST - API
• Security aspects
• Modules descriptions
• Internal mechanisms
• Database scheme
• Mixing OAR3 and OAR2
• Extensions
• Admin FAQ

Developer Documentation

• Development environment
• Usage
• Technical details and diagrams
• Contributing
• Changelog
• Create a new release

API reference

• Scheduling (oar.kao)
• oar.modules