Skip to main content

In Rancher Openstack; Now Install Kubernetes (Ironik); Python CLI Tool for deploying Kubernetes on OpenStack via Rancher.

Project description

PyPI Python Version Read the documentation at https://ironik.readthedocs.io/ pre-commit Black

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:

$ pip install ironik

Alternatively, ironik can also be used as a container to avoid installing it:

$ 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:

$ 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 for details.

Kubernetes can also be deployed manually on OpenStack and Rancher. See the Manual Deployment Instructions 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.)

sudo apt-get install build-essential libssl-dev libffi-dev python3-dev
  1. Install python packages

poetry install

Credits

This package was created with cookietemple using Cookiecutter based on Hypermodern_Python_Cookiecutter.

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

ironik-0.1.8.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

ironik-0.1.8-py3-none-any.whl (35.5 kB view details)

Uploaded Python 3

File details

Details for the file ironik-0.1.8.tar.gz.

File metadata

  • Download URL: ironik-0.1.8.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.11.6 Linux/6.6.16-1-lts

File hashes

Hashes for ironik-0.1.8.tar.gz
Algorithm Hash digest
SHA256 a34352a25a585f9d319cbd559352bb82968d34a44b3e0ce54cfac779e512e385
MD5 5ca93ad08164085a65aef55e94512011
BLAKE2b-256 5d782fa7ff6921d329aaa4cfa2ba40a6acfc7ea8364fb2688acc94224265d3e5

See more details on using hashes here.

File details

Details for the file ironik-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: ironik-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 35.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.11.6 Linux/6.6.16-1-lts

File hashes

Hashes for ironik-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b254c48a26ff15a12e4f6e8372feb96f7c9c40ca9b8b7695d649a09f480bfc0e
MD5 bea02558092c99f896a727e213d8c5c8
BLAKE2b-256 4bdaf46454cc30159719a5e891fe31b1b7beb4ffcc1edde0988376bd8c06bd58

See more details on using hashes here.

Supported by

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