Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add flux components slides #267

Merged
merged 5 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.7"
python: "3.11"
# You can also specify other tool versions:
# nodejs: "16"

Expand Down
1 change: 0 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@
"site_url": "http://flux-framework.github.io/flux-docs/",
"repo_url": "https://github.com/flux-framework/flux-docs/",
"repo_name": "Flux Framework",
"repo_type": "github",
"edit_uri": "blob/main",
"globaltoc_collapse": True,
"features": [
Expand Down
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
Copy link
Contributor

Choose a reason for hiding this comment

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

Is "architecture" the correct term here? This seems to be describing a high level overview of Flux Framework and many of the current components that are currently project under that umbrella. It could just be me, but when I see "Flux Architecture", I would expect to see something more along the lines of what's described here

Maybe this document should be called "Flux Framework Overview and Components"?

#################

.. 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>
1 change: 1 addition & 0 deletions guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Do you have a question? `let us know <https://github.com/flux-framework/flux-doc
:maxdepth: 1
:caption: Guides

architecture
Flux Administrator's Guide <https://flux-framework.readthedocs.io/projects/flux-core/en/latest/guide/admin.html>
accounting-guide
learning_guide
Expand Down
2 changes: 1 addition & 1 deletion guides/learning_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ distribution of these institutions.
:alt: Users are collaborators of Flux are quickly expanding around the world.
:align: center

Figure 8: Users are collaborators of Flux are quickly expanding around the world.
Figure 8: Users are collaborators of Flux are quickly expanding around the world.


*******************
Expand Down
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
6 changes: 2 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ sphinx-copybutton
docutils
Jinja2<3.1
markupsafe==2.0.1
# waiting on dark mode
# sphinx_material
sphinx-immaterial
pydantic==1.10.8
sphinx_immaterial
pydantic
recommonmark
sphinx_markdown_tables
myst-parser
Expand Down
3 changes: 2 additions & 1 deletion tutorials/commands/flux-jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,7 @@ By default, ``flux jobs`` will not list jobs that are running under subinstances
this with an example. Submit the following script to ``flux batch``.

.. code-block:: sh

#!/bin/sh
# filename: batchjob.sh

Expand All @@ -310,7 +311,7 @@ this with an example. Submit the following script to ``flux batch``.
flux queue drain

All we're doing is running two ``sleep`` jobs for infinity, and then calling ``flux queue drain`` to wait for those
jobs to complete. (See :ref:`Waiting for jobs<waiting-for-jobs>` tutorial for info on using ``flux queue drain`` to wait for jobs to complete.)
jobs to complete. Note that you can use ``flux queue drain`` to wait for jobs to complete.

Let's run this via ``flux batch``

Expand Down
Loading