Skip to content
An opinionated Kubernetes distribution with a focus on long-term on-prem deployments
Scheme Python JavaScript SaltStack Go Shell Other
Branch: development/2.4
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github github: Disable GitHub Actions Nov 19, 2019
artwork Generate required logos May 6, 2019
buildchain scripts: Add some `metadata` and `sha256sum` in backup archive Jan 20, 2020
charts charts: update `prometheus-operator` to 8.1.2 Jan 6, 2020
docs Merge branch 'documentation/2113-enhance-env-pre-req-list' into q/2.4 Jan 23, 2020
eve eve: Use minion id by default instead of hostname for create volume Jan 23, 2020
examples Remane Yup by yup to be consistent everywhere Oct 29, 2019
images build: Add custom grafana build image with plugins installed Jan 7, 2020
packages build/debian: Fix Saltstack repository URL Jan 15, 2020
scripts Merge branch 'bugfix/fix-backup-restore' into q/2.4 Jan 22, 2020
storage-operator ci: remove workaround Oct 10, 2019
tests Merge branch 'w/2.3/improvement/no-longer-use-hostname-in-tests' into… Jan 21, 2020
ui ui/doc: add cypress test for the documentation link Jan 15, 2020
.pylint-dict build: split build of metalk8s-ui app & image Dec 30, 2019
.pylintrc Fix task callables signatures and type hints Jul 31, 2019 Merge remote-tracking branch 'origin/development/2.4' into improvement/ Dec 17, 2019 add minimal file Mar 5, 2019
LICENSE Squashed 'buildchain/static-container-registry/' content from commit … May 22, 2019
VERSION Merge tag '2.4.1' into feature/merge-241-tag Nov 6, 2019
doit.cfg buildchain: `exec` `doit` at the end of `` Aug 29, 2019
tox.ini Merge remote-tracking branch 'origin/w/2.3/improvement/no-second-boot… Dec 16, 2019

MetalK8s logo

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 of standards for packaging such applications is respected.

For more information, please refer to the Integration Guidelines.


Prerequisites are listed here.

To build a MetalK8s ISO, simply type ./

For more information, please refer to the Building Documentation.


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



Bootstrapping a local environment

# Install virtualbox guest addition plugin
vagrant plugin install vagrant-vbguest
# Bootstrap a platform on a vagrant environment using
./ 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




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.