An opinionated Kubernetes distribution with a focus on long-term on-prem deployments
Building
To build a MetalK8s ISO, simply type ./doit.sh.
For more information, please refers to developer documentation.
Contributing
If you'd like to contribute, please review the Contributing Guidelines.
Testing
Requirements
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_upEnd-to-End Testing
To run the test-suite locally, first complete the bootstrap step as outline above
# Run tests with tox
tox -e testsDocumentation
Requirements
Building
To generate HTML documentation locally in docs/_build/html, run the following command:
# Generate doc with tox
tox -e docsMetalK8s version 1 is still maintained in this repository. See the
development/1.* branches, e. g.
MetalK8s 1.3 in the same
repository.
