README.md

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

Integrating

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

For more information, please refer to the Integration Guidelines.

Building

Prerequisites are listed here.

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

For more information, please refer to the Building Documentation.

Contributing

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

Testing

Requirements

• Python3.6+
• tox
• Vagrant
• VirtualBox

Bootstrapping a local environment

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

End-to-End Testing

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

# Run tests with tox
tox -e tests

Documentation

Requirements

• Python3.6+
• tox
• Plantuml

Building

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

# Generate doc with tox
tox -e docs

---

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