Skip to main content

Instance tree generation for organization or higher throughput submission

Project description

Flux Hierarchy

Create trees of Flux instances

PyPI version

https://github.com/converged-computing/flux-hierarchy/blob/main/img/flux-hierarchy-small.png?raw=true

This tool enables generation and orchestration of Flux hierarchies, or trees of instances. Such a setup can enable programmatic organization and submission of commands, or high throughput. Use cases we want to address:

  • Creation (and organization) of a Flux Hierarchy
  • Discovery of an existing Flux Hierarchy (e.g, for MCP)

Usage

Let's first create a hierarchy. This will be a Flux job. You'll need to be in a Flux instance where a handle is discoverable. E.g., in the DevContainer:

flux start

Then create a simple, flat hierarchy with all the resources allocated to one broker.

flux-hierarchy start ./examples/hierarchy-one.yaml

You can test throughput (this also starts the hierarchy):

flux-hierarchy throughput ./examples/hierarchy-one.yaml

For either of the above, the hierarchy will continue running (and you need to cancel the job).

flux cancel $(flux job last)

You can also view the shape of the hierarchy without running anything:

flux-hierarchy view ./examples/hierarchy-one.yaml
$ flux-hierarchy view ./examples/corona/hierarchy-2.yaml
=>
🌿 Leaf Broker Workers...{}
level1 [Nodes: 2]
    ├── level2 [Nodes: 1, Cores: 48]
    └── level2 [Nodes: 1, Cores: 48]

Development

To build and release:

python3 -m build
# or
python3 setup.py sdist bdist_wheel

twine upload dist/flux-hierarchy-<version>*

WIP

  • Developing a more robust way to organize / discover handles.
  • Then will test with throughput on more instances, etc.

License

HPCIC DevTools is distributed under the terms of the MIT license. All new contributions must be made under this license.

See LICENSE, COPYRIGHT, and NOTICE for details.

SPDX-License-Identifier: (MIT)

LLNL-CODE- 842614

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flux_hierarchy-0.0.11.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flux_hierarchy-0.0.11-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file flux_hierarchy-0.0.11.tar.gz.

File metadata

  • Download URL: flux_hierarchy-0.0.11.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for flux_hierarchy-0.0.11.tar.gz
Algorithm Hash digest
SHA256 c886e8556d86b4c3395e706b558805edf101893f74fa5b5b4079d50602307b93
MD5 7a07f81d5225ad3be5227e7f822b88f5
BLAKE2b-256 8149e4dcc5ba034944a81db8a38aafbac2b0c50914814401f4e05c85bdfc597e

See more details on using hashes here.

File details

Details for the file flux_hierarchy-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for flux_hierarchy-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1e4093738499136befa63e266ea15289d3942cf0e65785d741215e5132190cd1
MD5 018c8249cb451765a8e152196c81e9ef
BLAKE2b-256 0e73eb7efb7b9f8bc11de52a8a06057bae0bdefce0f1e3420ceb74d577675ab3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page