From c92d4a68cd096c8f7a10763d947908109b90c6be Mon Sep 17 00:00:00 2001 From: vsoch Date: Thu, 28 Mar 2024 16:24:44 -0600 Subject: [PATCH] feat: add flux abstractions (architecture) page 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 --- guides/architecture.rst | 18 ++++++++++++++++++ index.rst | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 guides/architecture.rst diff --git a/guides/architecture.rst b/guides/architecture.rst new file mode 100644 index 0000000..b02ddef --- /dev/null +++ b/guides/architecture.rst @@ -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 `_ + on our issue board. + + +.. raw:: html + + diff --git a/index.rst b/index.rst index ff2be9b..ddc5bc4 100644 --- a/index.rst +++ b/index.rst @@ -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