# fluxgen
> install and configure Flux Framework
This small library makes it easy to generate install scripts and configuration to get flux up and running!
We will run this in the context of a JobSet, with the goal to generate the scripts necessary to install flux, etc.
🚧 Under Construction! 🚧
## Usage
Fluxgen has two modes. If you use **create** you will create an install script that installs flux, creates configuration assets,
_and_ starts the brokers. if you use **install** it will just generate the install script.
### Install
Here is how to generate an install script.
```bash
# Preview in terminal
fluxgen install --dry-run
# Write to file
fluxgen install
```
```console
Writing install script to flux-install.sh
```
### Create
Here is an example for using fluxgen to generate an install script for a worker.
```bash
fluxgen create --brokers flux-sample[0-10] command arg1 arg2
```
And the lead broker:
```bash
fluxgen create --lead-broker --brokers flux-sample[0-10] command arg1 arg2
```
Just preview:
```bash
fluxgen create --lead-broker --brokers flux-sample[0-10] --dry-run command arg1 arg2
```
## License
HPCIC DevTools is distributed under the terms of the MIT license.
All new contributions must be made under this license.
See [LICENSE](https://github.com/converged-computing/cloud-select/blob/main/LICENSE),
[COPYRIGHT](https://github.com/converged-computing/cloud-select/blob/main/COPYRIGHT), and
[NOTICE](https://github.com/converged-computing/cloud-select/blob/main/NOTICE) for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE- 842614
Raw data
{
"_id": null,
"home_page": "https://github.com/converged-computing/fluxgen",
"name": "fluxgen",
"maintainer": "Vanessasaurus",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "multi-cluster, scheduler",
"author": "Vanessasaurus",
"author_email": "vsoch@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/5f/ef/78ddb3f94f1141a0194e1a21ee898fbdaad736b397c89ac23441573b7c8e/fluxgen-0.0.16.tar.gz",
"platform": null,
"description": "# fluxgen\n\n> install and configure Flux Framework\n\n\n\nThis small library makes it easy to generate install scripts and configuration to get flux up and running!\nWe will run this in the context of a JobSet, with the goal to generate the scripts necessary to install flux, etc.\n\n\ud83d\udea7 Under Construction! \ud83d\udea7\n\n## Usage\n\nFluxgen has two modes. If you use **create** you will create an install script that installs flux, creates configuration assets,\n_and_ starts the brokers. if you use **install** it will just generate the install script.\n\n### Install\n\nHere is how to generate an install script.\n\n```bash\n# Preview in terminal\nfluxgen install --dry-run\n\n# Write to file\nfluxgen install\n```\n```console\nWriting install script to flux-install.sh\n```\n\n### Create\n\nHere is an example for using fluxgen to generate an install script for a worker.\n\n```bash\nfluxgen create --brokers flux-sample[0-10] command arg1 arg2\n```\n\nAnd the lead broker:\n\n```bash\nfluxgen create --lead-broker --brokers flux-sample[0-10] command arg1 arg2\n```\n\nJust preview:\n\n```bash\nfluxgen create --lead-broker --brokers flux-sample[0-10] --dry-run command arg1 arg2\n```\n\n## License\n\nHPCIC DevTools is distributed under the terms of the MIT license.\nAll new contributions must be made under this license.\n\nSee [LICENSE](https://github.com/converged-computing/cloud-select/blob/main/LICENSE),\n[COPYRIGHT](https://github.com/converged-computing/cloud-select/blob/main/COPYRIGHT), and\n[NOTICE](https://github.com/converged-computing/cloud-select/blob/main/NOTICE) for details.\n\nSPDX-License-Identifier: (MIT)\n\nLLNL-CODE- 842614\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper tool to install and configure Flux Framework",
"version": "0.0.16",
"project_urls": {
"Homepage": "https://github.com/converged-computing/fluxgen"
},
"split_keywords": [
"multi-cluster",
" scheduler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "776ffa5c6762f3014ae6782ec67d6d20e6e2a593bf6469b7e9a68c632bfb0978",
"md5": "ae907a0a4292c6c7e9d809dffba579dd",
"sha256": "bd4814643b42b3b15fe5a7d978951c8ca5bae26e0cc6745dc3d970fde0626d62"
},
"downloads": -1,
"filename": "fluxgen-0.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae907a0a4292c6c7e9d809dffba579dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17357,
"upload_time": "2024-11-04T21:53:38",
"upload_time_iso_8601": "2024-11-04T21:53:38.479206Z",
"url": "https://files.pythonhosted.org/packages/77/6f/fa5c6762f3014ae6782ec67d6d20e6e2a593bf6469b7e9a68c632bfb0978/fluxgen-0.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fef78ddb3f94f1141a0194e1a21ee898fbdaad736b397c89ac23441573b7c8e",
"md5": "3ed49e9f04543d0d6beac721f520368a",
"sha256": "6b67183b843505f3a39923c793faf4d05f947c65599aaa3a7d2bf9506f814e0c"
},
"downloads": -1,
"filename": "fluxgen-0.0.16.tar.gz",
"has_sig": false,
"md5_digest": "3ed49e9f04543d0d6beac721f520368a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15057,
"upload_time": "2024-11-04T21:53:39",
"upload_time_iso_8601": "2024-11-04T21:53:39.934112Z",
"url": "https://files.pythonhosted.org/packages/5f/ef/78ddb3f94f1141a0194e1a21ee898fbdaad736b397c89ac23441573b7c8e/fluxgen-0.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 21:53:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "converged-computing",
"github_project": "fluxgen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fluxgen"
}
JSON
