Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scality/metalk8s

An opinionated Kubernetes distribution with a focus on long-term on-prem deployments
https://github.com/scality/metalk8s

artesca cloud cloud-native k8s k8s-cluster k8s-deployer k8s-install kubernetes kubernetes-cluster kubernetes-deployment kubernetes-distribution kubernetes-installation kubernetes-monitoring kubernetes-setup on-prem on-premise on-premises

Last synced: 6 days ago
JSON representation

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

Awesome Lists containing this project

README

        


MetalK8s logo

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](docs/developer/solutions/index.rst).

## Building

Prerequisites are listed [here](docs/developer/building/requirements.rst).

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

For more information, please refer to the
[Building Documentation](docs/developer/building/index.rst).

## Contributing

If you'd like to contribute, please review the
[Contributing Guidelines](CONTRIBUTING.md).

## Testing
### Requirements

- [Python3.6+](https://www.python.org/)
- [tox](https://pypi.org/project/tox)
- [Vagrant](https://www.vagrantup.com/)
- [VirtualBox](https://www.virtualbox.org)

### Bootstrapping a local environment

```shell
# 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:

```shell
# Run tests with tox
tox -e tests
```

## Documentation
### Requirements
- [Python3.6+](https://www.python.org/)
- [tox](https://pypi.org/project/tox)
- [Plantuml](http://plantuml.com/starting)

### Building

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

```shell
# 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](https://github.com/scality/metalk8s/tree/development/1.3).