Repository files navigation

An opinionated Kubernetes distribution with a focus on long-term on-prem deployments

MetalK8s offers a set of tools to deploy Kubernetes applications, given a set ofstandards for packaging such applications is respected.

For more information, please refer to theIntegration Guidelines.

Prerequisites are listedhere.

To build a MetalK8s ISO, simply type./doit.sh.

For more information, please refer to theBuilding Documentation.

If you'd like to contribute, please review theContributing Guidelines.

• Python3.6+
• tox
• Vagrant
• VirtualBox

# Install virtualbox guest addition pluginvagrant plugin install vagrant-vbguest# Bootstrap a platform on a vagrant environment using./doit.sh vagrant_up

To run the test-suite locally, first complete the bootstrap step as outlinedabove, then:

# Run tests with toxtox -e tests

• Python3.6+
• tox
• Plantuml

To generate HTML documentation locally indocs/_build/html, run the following command:

# Generate doc with toxtox -e docs

MetalK8s version 1 is still hosted in this repository but is no longer maintained.The last release isMetalK8s 1.3.