Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx_markdown_tables",
"sphinx_design",
"sphinx_immaterial.theme_result",
"sphinx_immaterial.kbd_keys",
"sphinx_immaterial.apidoc.format_signatures",
Expand Down
11 changes: 5 additions & 6 deletions faqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
FAQs
####

Some frequently asked questions about flux and their answers! 🤔️
Frequently asked questions about Flux 🤔

.. _background_faq:

Expand All @@ -16,10 +16,9 @@ Background
What is Flux Framework?
=======================

Flux is a flexible framework for resource management, built for your site.
The core framework here consists of a suite of projects, tools, and libraries that may be used to build site-custom resource managers for
High Performance Computing centers. The set of core projects are described in this documentation, and our
larger family of projects can be seen on `our portal page <https://flux-framework.org>`_.
Flux is a resource manager for high-performance computing. The core framework consists
of projects, tools, and libraries for building site-custom resource managers for HPC centers.
See our `portal page <https://flux-framework.org>`_ for the full family of projects.

What does it mean for a cluster to deploy Flux?
===============================================
Expand All @@ -43,7 +42,7 @@ How does Flux compare to other managers?
========================================

Flux has similarities to many other resource managers, but we do a variety of things quite differently.
Check out this comparison table here (:ref:`comparison-table`) for a detailed list!"
Check out the :ref:`comparison table <comparison-table>` for a detailed list.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could (and probably is) unrelated to this PR, but when the page containing the comparison table is loaded in dark mode, the License row still shows the license names in black text, which makes it pretty difficult to read. Maybe we should flip the font on those license to white when the page is in dark mode.

Do you want to add or correct a feature? Please `let us know <https://github.com/flux-framework/flux-docs/issues>`_

*****************
Expand Down
5 changes: 3 additions & 2 deletions guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
Guides
======

Read more about how to administer Flux, or use our Python API.
Do you have a question? `let us know <https://github.com/flux-framework/flux-docs/issues>`_
This section covers Flux administration, system components, and API documentation.

For questions or feedback, please `open an issue <https://github.com/flux-framework/flux-docs/issues>`_.

.. toctree::
:maxdepth: 1
Expand Down
155 changes: 110 additions & 45 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,66 +5,131 @@

SPDX-License-Identifier: (LGPL-3.0)

.. Flux documentation master file, created by
sphinx-quickstart on Fri Jan 10 15:11:07 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Flux's documentation!
================================
=============================
Flux Framework Documentation
=============================

.. image:: images/logo.png
:width: 600px
:width: 400px
:align: center

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.
Unlike traditional resource managers, Flux can run as a parallel job under most launchers that support MPI, including under Flux itself. This not only makes batch scripts and workflows for Flux portable to other resource managers (just launch Flux as a job), but it also means that batch jobs have all the features of a full resource manager at their disposal, as if they have an entire cluster to themselves.
If you are interested in a high level comparison of Flux to other resource managers, see :ref:`comparison-table`. If you want to get a high level overview of Flux projects or components, take a look at our :ref:`flux-components` page.
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.

.. toctree::
:maxdepth: 2
:caption: Contents
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.

quickstart
faqs
tutorials/index
jobs/index
guides/index
contributing
glossary
comics/index
:ref:`Compare Flux to Slurm/PBS/LSF <comparison-table>` |
:doc:`Get Started <core:guide/start>`

.. toctree::
:maxdepth: 1
:caption: Sub-Projects
---------------
Getting Started
---------------

projects
.. grid:: 3
:gutter: 2

.. toctree::
:maxdepth: 1
:caption: Comparison Table
.. grid-item-card:: 🚀 New to Flux

tables/comparison-table
- :doc:`Try Flux in Docker <tutorials/containers/flux-sched-container>`
- :doc:`Install Flux <core:guide/build>`
- :doc:`Tutorials <tutorials/index>`

.. grid-item-card:: 💻 Using Flux

Contributor Relevant RFCs
-------------------------
- :doc:`Command guide <core:guide/interact>`
- :doc:`Workflows <core:guide/workflows>`
- :doc:`Batch jobs <jobs/batch>`
- :doc:`Job hierarchies <jobs/hierarchies>`
- :doc:`Debugging jobs <jobs/debugging>`
- :ref:`Command references <core:man-pages>`

- :doc:`rfc:spec_1`
- :doc:`rfc:spec_2`
- :doc:`rfc:spec_7`
- :doc:`rfc:spec_9`
.. grid-item-card:: ⚙️ Administration/Development

- :doc:`Admin guide <core:guide/admin>`
- :doc:`Troubleshooting <core:guide/troubleshooting>`
- :doc:`Python API <core:python/index>`
- :doc:`C API <core:man3/index>`
- :ref:`Architecture & Components <flux-components>`
- :doc:`About the Flux broker <core:guide/broker>`

All RFCs
--------
------------
Manual Pages
------------

- :doc:`rfc:index`
**Command and API references:**
:ref:`core:man-pages` (job commands) |
:ref:`sched:man-pages` (scheduling) |
:ref:`security:man-pages` (security tools)

---------------
Installing Flux
---------------

Manual Pages
------------
**Start with** `flux-core <https://github.com/flux-framework/flux-core>`_
(:doc:`install guide <core:guide/build>`) for job execution, commands, APIs, and built-in schedulers.

**For advanced scheduling,** add `flux-sched <https://github.com/flux-framework/flux-sched>`_
(:doc:`install guide <sched:guide/build>`) to enable the fluxion scheduler with graph-based resource matching.

**For multi-user installations,** `flux-security <https://github.com/flux-framework/flux-security>`_
is required for authentication. `flux-accounting <https://github.com/flux-framework/flux-accounting>`_
provides resource accounting and priority management.

-------------
Flux Projects
-------------

Complete documentation for the core Flux projects:

.. grid:: 4
:gutter: 2

.. grid-item-card:: flux-core
:link: https://flux-framework.readthedocs.io/projects/flux-core/en/latest/

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

.. grid-item-card:: flux-sched
:link: https://flux-framework.readthedocs.io/projects/flux-sched/en/latest/

Fluxion scheduler with graph-based scheduling and resource matching

.. grid-item-card:: flux-accounting
:link: https://flux-framework.readthedocs.io/projects/flux-accounting/en/latest/

Multi-user resource accounting and priority management

.. grid-item-card:: flux-security
:link: https://flux-framework.readthedocs.io/projects/flux-security/en/latest/

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

**See also:** :doc:`flux-pmix, flux-coral2, dyad, and other projects <projects>`

.. toctree::
:maxdepth: 1
:hidden:

faqs
tutorials/index
jobs/index
guides/index
glossary
contributing
projects
tables/comparison-table

-----------
Quick Links
-----------

:doc:`FAQs <faqs>` |
:doc:`Tutorials <tutorials/index>` |
:doc:`Comics <comics/index>` 🎨 |
`Flux Website <https://flux-framework.org>`_

- :ref:`core:man-pages`
- :ref:`sched:man-pages`
- :ref:`security:man-pages`
**Technical:** :doc:`RFCs <rfc:index>` | :doc:`Contributing <contributing>`
8 changes: 6 additions & 2 deletions jobs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
Jobs
====

Here you can learn about Flux jobs - whether that be debugging, batch jobs, or job hierarchies.
Do you have a question? `let us know <https://github.com/flux-framework/flux-docs/issues>`_
A job is the smallest unit of work that can be allocated resources and run by Flux—typically
a parallel program, but it can also be a Flux instance that runs more jobs.

This section covers debugging jobs, running batch jobs, and managing job hierarchies.

For questions or feedback, please `open an issue <https://github.com/flux-framework/flux-docs/issues>`_.

.. toctree::
:maxdepth: 2
Expand Down
27 changes: 22 additions & 5 deletions projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,49 @@
Projects
========

This page provides a quick introduction to our core sub-projects! You can also find them along with associated projects on our `main portal page <https://flux-framework.org>`_.
This page provides an overview of Flux Framework projects. Additional projects and resources
are available on the `main portal page <https://flux-framework.org>`_.


---------
Flux Core
---------

Core resource manager with built-in schedulers, job execution, commands, and APIs.

- Read the `flux-core documentation <https://flux-framework.readthedocs.io/projects/flux-core/en/latest/index.html>`_

----------
Flux Sched
----------

Fluxion scheduler with graph-based scheduling and resource matching.

- Read the `flux-sched documentation <https://flux-framework.readthedocs.io/projects/flux-sched/en/latest/index.html>`_

---------------
Flux Accounting
---------------

Multi-user resource accounting and priority management.

- Read the `flux-accounting documentation <https://flux-framework.readthedocs.io/projects/flux-accounting/en/latest/index.html>`_

-------------
Flux Security
-------------

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

- Read the `flux-security documentation <https://flux-framework.readthedocs.io/projects/flux-security/en/latest/index.html>`_

---------------
Flux Accounting
---------------
---------
Flux PMIx
---------

- Read the `flux-accounting documentation <https://flux-framework.readthedocs.io/projects/flux-accounting/en/latest/index.html>`_
PMIx support for launching OpenMPI applications and enabling Flux to be launched by PMIx-capable systems.

- See the `flux-pmix repository <https://github.com/flux-framework/flux-pmix>`_

-----------
Flux CORAL2
Expand Down
Loading
Loading