Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
An opinionated Kubernetes distribution with a focus on long-term on-prem deployments
SaltStack Python Scheme JavaScript Go Shell Other
Branch: development/2.0
Clone or download
Pull request Compare This branch is 1412 commits behind development/2.4.
Cannot retrieve the latest commit at this time.
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
artwork
buildchain
charts
docs
eve
examples
images
packages
pillar
salt
scripts
tests
.dockerignore
.gitignore
.pylint-dict
.pylintrc
CONTRIBUTING.md
LICENSE
README.md
VERSION
Vagrantfile
doit.cfg
doit.sh
tox.ini

README.md

MetalK8s logo

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_up

End-to-End Testing

To run the test-suite locally, first complete the bootstrap step as outline above

# Run tests with tox
tox -e tests

Documentation

Requirements

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 maintained in this repository. See the development/1.* branches, e. g. MetalK8s 1.3 in the same repository.

You can’t perform that action at this time.