Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/checktor/virtkube
Local Kubernetes cluster with Vagrant.
https://github.com/checktor/virtkube
containerd flannel kubernetes kubernetes-cluster vagrant virtual-machine
Last synced: about 1 month ago
JSON representation
Local Kubernetes cluster with Vagrant.
- Host: GitHub
- URL: https://github.com/checktor/virtkube
- Owner: checktor
- Created: 2024-04-11T21:57:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-16T21:18:04.000Z (6 months ago)
- Last Synced: 2024-10-14T23:21:28.111Z (3 months ago)
- Topics: containerd, flannel, kubernetes, kubernetes-cluster, vagrant, virtual-machine
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# virtkube
virtkube implements a local Kubernetes cluster running on multiple virtual machines provisioned
by [Vagrant](https://www.vagrantup.com/). It uses [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/)
to set up the cluster from scratch based on minimal Ubuntu images for each node. In comparison
to [minikube](https://minikube.sigs.k8s.io/docs/), this tool does not provision a single-node cluster. The smallest
possible infrastructure consists of one controlplane and one worker node. This is intentional because virtkube's primary
goal is to provide a development cluster as close as possible to a productive Kubernetes deployment.
## Prerequisites
### Vagrant
Vagrant can be installed on macOS, Linux, and Windows. Follow
HashiCorp's [installation manual](https://developer.hashicorp.com/vagrant/install?product_intent=vagrant) for your
desired operating system.
### Virtualization tool like VirtualBox
Vagrant works with multiple virtualization tools. This project is tested with [VirtualBox](https://www.virtualbox.org/).
Consult the [official documentation](https://www.virtualbox.org/wiki/Downloads) for further information on the
installation procedure.
## Cluster management
### Create cluster
```shell
vagrant up
```
### Configure kubectl to work with cluster
Use `kubeconfig` file in [sync](sync) folder for kubectl authentication.
```shell
export KUBECONFIG=/path/to/sync/kubeconfig
kubectl get pods -A
```
### Connect to cluster VMs
You can access a specific cluster VM by running `vagrant ssh `, e.g. `vagrant ssh worker_0` to connect to first
worker node.
### Remove cluster
```shell
vagrant destroy -f
```
## Integration tests
Use Helm chart in [canary](canary) folder to test Kubernetes cluster setup. You might need to
install [Helm](https://helm.sh/) first.
### Install chart
```shell
export KUBECONFIG=/path/to/sync/kubeconfig
helm install canary ./canary
```
### Execute tests
```shell
helm test canary
```
You might need to manually delete `canary-test-connection` pod by running `kubectl delete pod canary-test-connection`
before re-executing the tests.
### Remove chart
```shell
helm uninstall canary
```
## Cluster configuration
The number of controlplane and worker nodes can be configured using `num_controlplanes` and `num_workers` variables
in [Vagrantfile](Vagrantfile). In case multiple controlplane nodes are configured, a corresponding load balancer based
on [HAProxy](https://www.haproxy.org/) will be provisioned.
## Further tools
The following dependencies are used to provision the cluster:
* Container runtime: [containerd](https://github.com/containerd/containerd)
* CNI plugin: [flannel](https://github.com/flannel-io/flannel)