Skip to content

Code for compute nodes for while-true-do.io.

License

Notifications You must be signed in to change notification settings

whiletruedoio/kube.while-true-do.io

Cirrus CI - Base Branch Build Status CodeFactor GitHub release (latest SemVer) GitHub issues GitHub pull requests GitHub license

kube.while-true-do.io

Kubernetes nodes for deployments of while-true-do.io.

Disclaimer

This repository is under heavy development and not released, yet. All code is subject to change and considered "broken" until it is released.

Motivation

Running Kubernetes can be done in different ways. Since we want to have a reproducible setup for home, IoT, clustered and single node deployments, we need a fitting Kubernetes configuration.

Description

kube.while-true-do.io represents the compute nodes, which can be reproduced at home and in the cloud.

Usage

We are really happy, that you consider using our software. In case you want to install and run the code on your machine, please check out this section.

Requirements

You will need the possibility to deploy at least a single virtual machine or bare metal machine, which represents the below requirements.

Minimum:

  • CPU: 2 cores
  • RAM: 2 GB
  • Disk: 100 GB

Recommended:

  • CPU: 4 cores
  • RAM: 4 GB
  • Disk: 200 GB

Install

Boot ISO

TODO: Describe the installation with the ISO.

Cloud Image

TODO: Describe the installation with Cloud Init.

Configure

TODO: Describe the configuration of a deployed node via Ansible.

Update

TODO: Describe the update process of a deployed node via Ansible.

Deploy

TODO: Describe the deployment of workload on a configured node.

Contribute

Thank you so much for considering to contribute! We are happy, when someone is joining the hard work. Please have a look at the Contributor Conventions beforehand.

Issues

Issues and Pull Requests are handled on a regular basis. Please be aware, that we may reach out to you, ask you to provide additional resources or want to discuss the issue a little, before planning it.

Develop

Changelog

We are maintaining a changelog for repositories. Normally, the developers will update the changelog, according to keepachangelog.com.

Test

To ensure a high quality and functionality, we want to carefully test our software.

License

Except otherwise noted, all work is licensed under a BSD-3-Clause License.

Contact

Please feel free to reach out to us and the community. We also recommend to read and understand the Code of Conduct beforehand.