| Name | ironik JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | https://gitlab.gwdg.de/jonathan.decker1/ironik |
| Summary | In Rancher Openstack; Now Install Kubernetes (Ironik); Python CLI Tool for deploying Kubernetes on OpenStack via Rancher. |
| upload_time | 2024-02-09 16:08:27 |
| maintainer | |
| docs_url | None |
| author | Jonathan Decker |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ironik
======
|PyPI| |Python Version| |Read the Docs| |pre-commit| |Black|
.. |PyPI| image:: https://img.shields.io/pypi/v/ironik.svg
:target: https://pypi.org/project/ironik/
:alt: PyPI
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/ironik
:target: https://pypi.org/project/ironik
:alt: Python Version
.. |Read the Docs| image:: https://img.shields.io/readthedocs/ironik/latest.svg?label=Read%20the%20Docs
:target: https://ironik.readthedocs.io/
:alt: Read the documentation at https://ironik.readthedocs.io/
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
.. Warning:: THIS PROJECT HAS BEEN MOVED TO https://gitlab-ce.gwdg.de/jdecker/ironik
.. Warning:: This tool is still in early development and only the core features are available.
Features
--------
- Utilize OpenStack and Rancher APIs to automatically deploy Kubernetes cluster
- Customize the configuration using templates
- Install new Kubernetes versions including deploying the external cloud controller manager for OpenStack
Installation
------------
You can install *ironik* via pip_ from PyPI_:
.. code:: console
$ pip install ironik
Alternatively, *ironik* can also be used as a container to avoid installing it:
.. code:: console
$ docker run --rm -ti -v $(pwd):/app/tmp docker.gitlab-ce.gwdg.de/jdecker/ironik/cli:latest ironik --help
This can be abbreviated using an alias:
.. code:: console
$ alias dironik='docker run --rm -ti -v $(pwd):/app/tmp docker.gitlab-ce.gwdg.de/jdecker/ironik/cli:latest ironik'
$ dironik --help
Usage
-----
Please see the `Usage Instructions <https://ironik.readthedocs.io/en/latest/cli_usage.html>`_ for details.
Kubernetes can also be deployed manually on OpenStack and Rancher.
See the `Manual Deployment Instructions <https://ironik.readthedocs.io/en/latest/manual_kubernetes_deployment.html>`_ for a full guide.
TODOs
-----
- Update Code documentation to use Google code doc style
- Improve print messages during execution
- Implement a template validator
- Implement cluster validation
- Set up test suite
- Implement automatic config fetching
- Add functionality for undoing deployments and other helpful commands
Contributing
------------
Contributions are very welcome. To learn more, see the `Contributor Guide`_.
Setup Development Environment
-----------------------------
We tested the developing environment with Ubuntu 22.04.
1. Fork project
2. Clone forked project on your working machine
3. Install dependencies (needed to build wheel of netifaces in Step 4.)
.. code:: console
sudo apt-get install build-essential libssl-dev libffi-dev python3-dev
4. Install python packages
.. code:: console
poetry install
Credits
-------
This package was created with cookietemple_ using Cookiecutter_ based on Hypermodern_Python_Cookiecutter_.
.. _cookietemple: https://cookietemple.com
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT: http://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern_Python_Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _pip: https://pip.pypa.io/
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://ironik.readthedocs.io/en/latest/usage.html
Raw data
{
"_id": null,
"home_page": "https://gitlab.gwdg.de/jonathan.decker1/ironik",
"name": "ironik",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Jonathan Decker",
"author_email": "jonathan.decker@uni-goettingen.de",
"download_url": "https://files.pythonhosted.org/packages/5d/78/2fa7ff6921d329aaa4cfa2ba40a6acfc7ea8364fb2688acc94224265d3e5/ironik-0.1.8.tar.gz",
"platform": null,
"description": "ironik\n======\n\n|PyPI| |Python Version| |Read the Docs| |pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/ironik.svg\n :target: https://pypi.org/project/ironik/\n :alt: PyPI\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/ironik\n :target: https://pypi.org/project/ironik\n :alt: Python Version\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/ironik/latest.svg?label=Read%20the%20Docs\n :target: https://ironik.readthedocs.io/\n :alt: Read the documentation at https://ironik.readthedocs.io/\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\n.. Warning:: THIS PROJECT HAS BEEN MOVED TO https://gitlab-ce.gwdg.de/jdecker/ironik\n\n.. Warning:: This tool is still in early development and only the core features are available.\n\nFeatures\n--------\n\n- Utilize OpenStack and Rancher APIs to automatically deploy Kubernetes cluster\n- Customize the configuration using templates\n- Install new Kubernetes versions including deploying the external cloud controller manager for OpenStack\n\nInstallation\n------------\n\nYou can install *ironik* via pip_ from PyPI_:\n\n.. code:: console\n\n $ pip install ironik\n\nAlternatively, *ironik* can also be used as a container to avoid installing it:\n\n.. code:: console\n\n $ docker run --rm -ti -v $(pwd):/app/tmp docker.gitlab-ce.gwdg.de/jdecker/ironik/cli:latest ironik --help\n\nThis can be abbreviated using an alias:\n\n.. code:: console\n\n $ alias dironik='docker run --rm -ti -v $(pwd):/app/tmp docker.gitlab-ce.gwdg.de/jdecker/ironik/cli:latest ironik'\n $ dironik --help\n\nUsage\n-----\n\nPlease see the `Usage Instructions <https://ironik.readthedocs.io/en/latest/cli_usage.html>`_ for details.\n\nKubernetes can also be deployed manually on OpenStack and Rancher.\nSee the `Manual Deployment Instructions <https://ironik.readthedocs.io/en/latest/manual_kubernetes_deployment.html>`_ for a full guide.\n\nTODOs\n-----\n\n- Update Code documentation to use Google code doc style\n- Improve print messages during execution\n- Implement a template validator\n- Implement cluster validation\n- Set up test suite\n- Implement automatic config fetching\n- Add functionality for undoing deployments and other helpful commands\n\nContributing\n------------\n\nContributions are very welcome. To learn more, see the `Contributor Guide`_.\n\nSetup Development Environment\n-----------------------------\nWe tested the developing environment with Ubuntu 22.04.\n\n1. Fork project\n2. Clone forked project on your working machine\n3. Install dependencies (needed to build wheel of netifaces in Step 4.)\n\n.. code:: console\n\n sudo apt-get install build-essential libssl-dev libffi-dev python3-dev\n\n4. Install python packages\n\n.. code:: console\n\n poetry install\n\n\nCredits\n-------\n\nThis package was created with cookietemple_ using Cookiecutter_ based on Hypermodern_Python_Cookiecutter_.\n\n.. _cookietemple: https://cookietemple.com\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _MIT: http://opensource.org/licenses/MIT\n.. _PyPI: https://pypi.org/\n.. _Hypermodern_Python_Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n.. _pip: https://pip.pypa.io/\n.. _Contributor Guide: CONTRIBUTING.rst\n.. _Usage: https://ironik.readthedocs.io/en/latest/usage.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "In Rancher Openstack; Now Install Kubernetes (Ironik); Python CLI Tool for deploying Kubernetes on OpenStack via Rancher.",
"version": "0.1.8",
"project_urls": {
"Documentation": "https://ironik.readthedocs.io",
"Homepage": "https://gitlab.gwdg.de/jonathan.decker1/ironik",
"Repository": "https://gitlab.gwdg.de/jonathan.decker1/ironik"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bdaf46454cc30159719a5e891fe31b1b7beb4ffcc1edde0988376bd8c06bd58",
"md5": "bea02558092c99f896a727e213d8c5c8",
"sha256": "b254c48a26ff15a12e4f6e8372feb96f7c9c40ca9b8b7695d649a09f480bfc0e"
},
"downloads": -1,
"filename": "ironik-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bea02558092c99f896a727e213d8c5c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 35547,
"upload_time": "2024-02-09T16:08:25",
"upload_time_iso_8601": "2024-02-09T16:08:25.802280Z",
"url": "https://files.pythonhosted.org/packages/4b/da/f46454cc30159719a5e891fe31b1b7beb4ffcc1edde0988376bd8c06bd58/ironik-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d782fa7ff6921d329aaa4cfa2ba40a6acfc7ea8364fb2688acc94224265d3e5",
"md5": "5ca93ad08164085a65aef55e94512011",
"sha256": "a34352a25a585f9d319cbd559352bb82968d34a44b3e0ce54cfac779e512e385"
},
"downloads": -1,
"filename": "ironik-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "5ca93ad08164085a65aef55e94512011",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 30067,
"upload_time": "2024-02-09T16:08:27",
"upload_time_iso_8601": "2024-02-09T16:08:27.404689Z",
"url": "https://files.pythonhosted.org/packages/5d/78/2fa7ff6921d329aaa4cfa2ba40a6acfc7ea8364fb2688acc94224265d3e5/ironik-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-09 16:08:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ironik"
}
