Skip to content

Commit

Permalink
feat: add flux abstractions (architecture) page
Browse files Browse the repository at this point in the history
Problem: the flux components are diverse and can be confusing.
Solution: create an architecture page that includes a short
set of slides that go over high level concepts and projects.

Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch committed Mar 28, 2024
1 parent 94be8fa commit c92d4a6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions guides/architecture.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _flux-architecture:

#################
Flux Architecture
#################

.. note::
Flux is a Framework because we assemble several components together
to manifest in the workload manager known as Flux. The slides below
review some of the projects and terminology. If there is a component
or abstraction that you don't see here (and would like to) please let
us know by `opening an issue <https://github.com/flux-framework/flux-docs/issues>`_
on our issue board.


.. raw:: html

<iframe src="https://docs.google.com/presentation/d/e/2PACX-1vR-Q6HGJxTpCoHR7lfI1kCSwYJ7zLkP4egHUMLDK4QTR3Ua305_oXJ0ksoKDchTlLFRQxXjX2MbLJId/embed?start=false&loop=false&delayms=60000" frameborder="0" width="960" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ 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.
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 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-architecture` page.

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit c92d4a6

Please sign in to comment.