{"id":15090224,"url":"https://github.com/checktor/virtkube","last_synced_at":"2026-01-05T02:12:02.162Z","repository":{"id":234321392,"uuid":"785436011","full_name":"checktor/virtkube","owner":"checktor","description":"Local Kubernetes cluster with Vagrant.","archived":false,"fork":false,"pushed_at":"2024-07-16T21:18:04.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-26T11:43:11.608Z","etag":null,"topics":["containerd","flannel","kubernetes","kubernetes-cluster","vagrant","virtual-machine"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checktor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-11T21:57:11.000Z","updated_at":"2024-07-16T21:18:08.000Z","dependencies_parsed_at":"2024-07-16T23:54:19.090Z","dependency_job_id":null,"html_url":"https://github.com/checktor/virtkube","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"26b0fce716085d38848d269d09393221e1abfc97"},"previous_names":["checktor/virtkube"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checktor%2Fvirtkube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checktor%2Fvirtkube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checktor%2Fvirtkube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checktor%2Fvirtkube/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checktor","download_url":"https://codeload.github.com/checktor/virtkube/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244826688,"owners_count":20516806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["containerd","flannel","kubernetes","kubernetes-cluster","vagrant","virtual-machine"],"created_at":"2024-09-25T09:23:41.164Z","updated_at":"2026-01-05T02:12:02.157Z","avatar_url":"https://github.com/checktor.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# virtkube\n\nvirtkube implements a local Kubernetes cluster running on multiple virtual machines provisioned\nby [Vagrant](https://www.vagrantup.com/). It uses [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/)\nto set up the cluster from scratch based on minimal Ubuntu images for each node. In comparison\nto [minikube](https://minikube.sigs.k8s.io/docs/), this tool does not provision a single-node cluster. The smallest\npossible infrastructure consists of one controlplane and one worker node. This is intentional because virtkube's\nprimary goal is to provide a development cluster as close as possible to a productive Kubernetes deployment.\n\n## Prerequisites\n\n### Vagrant\n\nVagrant can be installed on macOS, Linux, and Windows. Follow\nHashiCorp's [installation manual](https://developer.hashicorp.com/vagrant/install?product_intent=vagrant) for your\ndesired operating system.\n\n### Virtualization tool like VirtualBox\n\nVagrant works with multiple virtualization tools. This project is tested with [VirtualBox](https://www.virtualbox.org/).\nConsult the [official documentation](https://www.virtualbox.org/wiki/Downloads) for further information on the\ninstallation procedure.\n\n## Cluster management\n\n### Create cluster\n\n```shell\nvagrant up\n```\n\n### Configure kubectl to work with cluster\n\nUse `kubeconfig` file in [sync](sync) folder for kubectl authentication.\n\n```shell\nexport KUBECONFIG=/path/to/sync/kubeconfig\nkubectl get pods -A\n```\n\n### Connect to cluster VMs\n\nYou can access a specific cluster VM by running `vagrant ssh \u003cVM-name\u003e`, e.g. `vagrant ssh worker_0` to connect to first\nworker node.\n\n### Remove cluster\n\n```shell\nvagrant destroy -f\n```\n\n## Integration tests\n\nUse Helm chart in [canary](canary) folder to test Kubernetes cluster setup. You might need to\ninstall [Helm](https://helm.sh/) first.\n\n### Install chart\n\n```shell\nexport KUBECONFIG=/path/to/sync/kubeconfig\nhelm install canary ./canary\n```\n\n### Execute tests\n\n```shell\nhelm test canary\n```\n\nYou might need to manually delete `canary-test-connection` pod by running `kubectl delete pod canary-test-connection`\nbefore re-executing the tests.\n\n### Remove chart\n\n```shell\nhelm uninstall canary\n```\n\n## Cluster configuration\n\nThe number of controlplane and worker nodes can be configured using `num_controlplanes` and `num_workers` variables\nin [Vagrantfile](Vagrantfile). In case multiple controlplane nodes are configured, a corresponding load balancer based\non [HAProxy](https://www.haproxy.org/) will be provisioned.\n\n## Further tools\n\nThe following dependencies are used to provision the cluster:\n\n* Container runtime: [containerd](https://github.com/containerd/containerd)\n* CNI plugin: [flannel](https://github.com/flannel-io/flannel)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchecktor%2Fvirtkube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchecktor%2Fvirtkube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchecktor%2Fvirtkube/lists"}