# usernetes (python)
> Python SDK and client to deploy user space Kubernetes (usernetes)
[](https://badge.fury.io/py/usernetes)
This is a library in Python to easily deploy [Usernetes](https://github.com/rootless-containers/usernetes).
It is implemented in Python anticipating being used by Flux Framework, which has the most feature rich SDK
written in Python. Note that I haven't added support for other container runtimes (e.g., nerdctl) yet
since I'm just adding core functionality, but this would be easy to do.
🚧 Under Development 🚧
## Orchestration
The following setups are available:
- [flux-framework](scripts/flux): assumes a shared filesystem
- [aws](scripts/aws): (with Flux, assuming no shared filesystem) is coming soon!
See the logic in [scripts/flux/start-usernetes.sh](scripts/flux/start-usernetes.sh) and [scripts/flux/stop-usernetes.sh](scripts/flux/stop-usernetes.sh) for logic to bring up and down a cluster. For Flux, these are intending to be run as perilog and epilog scripts, before and after a batch job, respectively, and given that a particular environment variable is set. If you add a set of scripts (and instructions) for your environment, please open a pull request here to add code and instructions!
*This library has not been fully tested yet, waiting for development environments!*
## 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/usernetes-python",
"name": "usernetes",
"maintainer": "Vanessa Sochat",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "cluster, orchestration, user-space kubernetes, kubernetes, compose",
"author": "Vanessa Sochat",
"author_email": "vsoch@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f9/c5/a5b181fff2c07f7c049aa0325e051e05b2fb649992314668898997675ce4/usernetes-0.0.11.tar.gz",
"platform": null,
"description": "# usernetes (python)\n\n> Python SDK and client to deploy user space Kubernetes (usernetes)\n\n[](https://badge.fury.io/py/usernetes)\n\nThis is a library in Python to easily deploy [Usernetes](https://github.com/rootless-containers/usernetes).\nIt is implemented in Python anticipating being used by Flux Framework, which has the most feature rich SDK\nwritten in Python. Note that I haven't added support for other container runtimes (e.g., nerdctl) yet\nsince I'm just adding core functionality, but this would be easy to do.\n\n\ud83d\udea7 Under Development \ud83d\udea7\n\n## Orchestration\n\nThe following setups are available:\n\n- [flux-framework](scripts/flux): assumes a shared filesystem\n- [aws](scripts/aws): (with Flux, assuming no shared filesystem) is coming soon!\n\nSee the logic in [scripts/flux/start-usernetes.sh](scripts/flux/start-usernetes.sh) and [scripts/flux/stop-usernetes.sh](scripts/flux/stop-usernetes.sh) for logic to bring up and down a cluster. For Flux, these are intending to be run as perilog and epilog scripts, before and after a batch job, respectively, and given that a particular environment variable is set. If you add a set of scripts (and instructions) for your environment, please open a pull request here to add code and instructions!\n\n*This library has not been fully tested yet, waiting for development environments!*\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": "LICENSE",
"summary": "Python wrapper for user-space Kubernetes 'usernetes'",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/converged-computing/usernetes-python"
},
"split_keywords": [
"cluster",
" orchestration",
" user-space kubernetes",
" kubernetes",
" compose"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc22b4c8643d109dc887c7823dd1d1dd6ac1b2c48560675c23e50fafbca3d92f",
"md5": "f70cc8613d2027df63b312fa94f5e73e",
"sha256": "3ae17a24727de9361e98cfaf5ab3c726ab562be5dd68bb732066f061e332d871"
},
"downloads": -1,
"filename": "usernetes-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f70cc8613d2027df63b312fa94f5e73e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 42676,
"upload_time": "2024-12-11T07:03:48",
"upload_time_iso_8601": "2024-12-11T07:03:48.517226Z",
"url": "https://files.pythonhosted.org/packages/dc/22/b4c8643d109dc887c7823dd1d1dd6ac1b2c48560675c23e50fafbca3d92f/usernetes-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9c5a5b181fff2c07f7c049aa0325e051e05b2fb649992314668898997675ce4",
"md5": "0190136e917c0c7ab5a3185a66ddb517",
"sha256": "696d5d8c7b354ba861ddfc53c5a5c43ca946b93b81d159e9be1e2d8f9606f0c1"
},
"downloads": -1,
"filename": "usernetes-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "0190136e917c0c7ab5a3185a66ddb517",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18342,
"upload_time": "2024-12-11T07:03:50",
"upload_time_iso_8601": "2024-12-11T07:03:50.651111Z",
"url": "https://files.pythonhosted.org/packages/f9/c5/a5b181fff2c07f7c049aa0325e051e05b2fb649992314668898997675ce4/usernetes-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 07:03:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "converged-computing",
"github_project": "usernetes-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "usernetes"
}
JSON
