# Flux Burst Plugin for Compute Engine
This is an example implementation for an external bursting plugin for Flux.
For instructions, see the [main flux-burst repository](https://github.com/converged-computing/flux-burst).
Tutorials are available under the [flux operator](https://github.com/flux-framework/flux-operator/tree/main/examples/experimental/bursting)
![https://raw.githubusercontent.com/converged-computing/flux-burst/main/docs/assets/img/logo.png](https://raw.githubusercontent.com/converged-computing/flux-burst/main/docs/assets/img/logo.png)
## Usage
- This plugin requires *terraform* to be installed.
- For a bursted cluster (connecting one broker to another) you can use build [these images](https://github.com/converged-computing/flux-terraform-gcp/tree/main/build-images/bursted) with `make`.
- See the [example alongside the Flux Operator](https://github.com/flux-framework/flux-operator/tree/main/examples/experimental/bursting/broker-compute-engine) for bursting from GKE to Compute Engine.
- Isolated bursts are not fully supported yet - the image needs to be refactored for it!
If you are connecting clusters, they need to be compatible! See [the notes here](https://gist.github.com/vsoch/1801ffcba1eda5ca6ea65e03f9b5fa6c).
## TODO
- We likely want to be able to handle different operating systems - right now the burst is setup for Rocky Linux.
## 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/flux-burst/blob/main/LICENSE),
[COPYRIGHT](https://github.com/converged-computing/flux-burst/blob/main/COPYRIGHT), and
[NOTICE](https://github.com/converged-computing/flux-burst/blob/main/NOTICE) for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE- 842614
Raw data
{
"_id": null,
"home_page": "https://github.com/converged-computing/flux-burst-compute-engine",
"name": "flux-burst-compute-engine",
"maintainer": "Vanessa Sochat",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "flux,flux-framework,workflow,example,plugin",
"author": "Vanessa Sochat",
"author_email": "vsoch@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/b1/04/95ccee2c72fe1d7eada8c5f69f7b6bf458940e3a6cfd044dfcb18ede89dd/flux-burst-compute-engine-0.0.12.tar.gz",
"platform": null,
"description": "# Flux Burst Plugin for Compute Engine\n\nThis is an example implementation for an external bursting plugin for Flux.\nFor instructions, see the [main flux-burst repository](https://github.com/converged-computing/flux-burst).\nTutorials are available under the [flux operator](https://github.com/flux-framework/flux-operator/tree/main/examples/experimental/bursting)\n\n![https://raw.githubusercontent.com/converged-computing/flux-burst/main/docs/assets/img/logo.png](https://raw.githubusercontent.com/converged-computing/flux-burst/main/docs/assets/img/logo.png)\n\n## Usage\n\n - This plugin requires *terraform* to be installed.\n - For a bursted cluster (connecting one broker to another) you can use build [these images](https://github.com/converged-computing/flux-terraform-gcp/tree/main/build-images/bursted) with `make`.\n - See the [example alongside the Flux Operator](https://github.com/flux-framework/flux-operator/tree/main/examples/experimental/bursting/broker-compute-engine) for bursting from GKE to Compute Engine.\n - Isolated bursts are not fully supported yet - the image needs to be refactored for it!\n\nIf you are connecting clusters, they need to be compatible! See [the notes here](https://gist.github.com/vsoch/1801ffcba1eda5ca6ea65e03f9b5fa6c).\n\n## TODO\n\n - We likely want to be able to handle different operating systems - right now the burst is setup for Rocky Linux.\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/flux-burst/blob/main/LICENSE),\n[COPYRIGHT](https://github.com/converged-computing/flux-burst/blob/main/COPYRIGHT), and\n[NOTICE](https://github.com/converged-computing/flux-burst/blob/main/NOTICE) for details.\n\nSPDX-License-Identifier: (MIT)\n\nLLNL-CODE- 842614\n\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "A bursting plugin for Flux and Compute Engine on Google Cloud",
"version": "0.0.12",
"project_urls": {
"Homepage": "https://github.com/converged-computing/flux-burst-compute-engine"
},
"split_keywords": [
"flux",
"flux-framework",
"workflow",
"example",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b10495ccee2c72fe1d7eada8c5f69f7b6bf458940e3a6cfd044dfcb18ede89dd",
"md5": "0b74d14d5f444da94fc7741a253e4738",
"sha256": "488ae087c44585308dfa0251cf4918469e91516cec8c22cdb67902dc534c7dcf"
},
"downloads": -1,
"filename": "flux-burst-compute-engine-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "0b74d14d5f444da94fc7741a253e4738",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14953,
"upload_time": "2023-07-17T01:58:32",
"upload_time_iso_8601": "2023-07-17T01:58:32.735038Z",
"url": "https://files.pythonhosted.org/packages/b1/04/95ccee2c72fe1d7eada8c5f69f7b6bf458940e3a6cfd044dfcb18ede89dd/flux-burst-compute-engine-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 01:58:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "converged-computing",
"github_project": "flux-burst-compute-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flux-burst-compute-engine"
}