kaweezle

Kaweezle

Run Vanilla Kubernetes on Windows with WSL 2 and Alpine Linux
Explore the docs »

Report Bug · Request Feature

About The Project

Kaweezle allows running a Kubernetes cluster on Windows using Windows Subsystem for Linux 2 (WSL 2).

It works in a way similar to Rancher Desktop, but it's simpler and is fully CLI based.

It is based on Alpine Linux. The resulting WSL distribution can also be used for building Docker images with the help of Postman.

(back to top)

Built With

This project uses the following components:

• go
• cobra
• logrus
• pterm

(back to top)

Getting Started

Kaweezle is better installed with Scoop. The following assumes you are using it.

Prerequisites

To run kaweezle, you'll need to have WSL installed.

The simplest way to install it is to run the following command:

> wsl --install

After reboot, update the kernel and set the default version to version 2:

> sudo wsl --update
> wsl --set-default-version 2

To use the kubernetes cluster, you will need to have kubectl installed:

> scoop install kubectl

Other tools might be of insterest, like k9s, kubectx, kubens or stern. All are available through scoop. You can install all of them at once with the following command:

> scoop install k9s kubectx kubens stern

Installation

To install kaweezle, issue the following command:

> scoop bucket add kaweezle https://github.com/kaweezle/scoop-bucket
> scoop install kaweezle

(back to top)

Usage

First, install the kaweezle distribution with the following command:

> kaweezle start

This will install the Kaweezle distribution, start it and install kubernetes on it.

At the end of the installation you will have the following:

• The kaweezle distribution, running the current version of Kubernetes.
• A kaweezle kube context allowing to access the cluster.

TODO: Need some DNS to access the LB entrypoint ?

(back to top)

Roadmap

• Finish install command
• Make rootfs downloadable
• Make kaweezle installable via scoop
• Make kaweezle available on scoop extras bucket
• ...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License. See LICENSE for more information.

(back to top)

Contact

Kaweezle - @kaweezle

Project Link: https://github.com/kaweezle/kaweezle

(back to top)

Acknowledgments

This project started from the amazing work made by yuk7 with wsldl and AlpineWSL.

It also uses the great work made by the Alpine Linux community on the edge repository.

You may be interested by existing alternatives from which we have taken some ideas:

• Rancher Desktop
• Minikube
• Kind

By using kubeadm and Alpine, kaweezle is closer to the clusters you may use on public clouds.

This readme has has been created from the Best-README-Template project.

(back to top)