Compare commits

..
2 Commits
Author SHA1 Message Date
bartal-lsn 9ef3048371 readme changes 2026-09-29 22:04:32 +01:00
bartal-lsn 297095c29a rm license 2026-09-29 21:53:50 +01:00
+10 -28
View File
@@ -1,25 +1,23 @@
# Kubernetes Local Development Environment
Only tested on Ubuntu-24.04 wsl
## Overview
This project provides tools to create and manage local Kubernetes development environments using Multipass VMs. It enables you to quickly set up fully functional Kubernetes clusters on your local machine for testing, development, or learning.
## Quick Start
```bash
# Please install golang v1.22 or greater before starting
# and multipass, and ansible
# Golang
sudo apt install golang
# Ansible (Please double check installation process yourself if this is outdated)
# Install golang >= 1.22, Multipass, and Ansible before starting
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository --yes --update ppa:ansible/ansible
sudo apt install golang
sudo apt install ansible
# multipass (If you encounter authentication error, please follow step 6 in troubleshooting section
sudo snap install multipass
# Run provisioning
# PROVISIONING
# Option 1: Using CLI tool (recommended)
./cli/build.sh # build CLI tool in project
./provision-cli provision # Run interactive provisioning in project root
@@ -32,10 +30,6 @@ multipass shell controlplane
kubectl get nodes
```
## Overview
This project provides tools to create and manage local Kubernetes development environments using Multipass VMs. It enables you to quickly set up fully functional Kubernetes clusters on your local machine for testing, development, or learning.
## Installation
### Prerequisites
@@ -45,14 +39,10 @@ This project provides tools to create and manage local Kubernetes development en
- [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/index.html) - for configuration
- SSH tools (OpenSSH client)
- Python 3
- Golang v1.22 or greater (is currently used for building binary)
- Go 1.22
### CLI Tool (Recommended)
It is currently required to have golang v1.22 or greater to build the provision-cli.
On Ubuntu 24.04 you can just run `sudo apt install golang`
The CLI tool provides a user-friendly interface for managing your environments:
```bash
# build CLI tool
./cli/build.sh
@@ -154,11 +144,3 @@ snap restart multipass
You may need sudo with this last command: `sudo snap restart multipass.`
At this point, your client should be authenticated with the Multipass service.
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
## License
[MIT License](LICENSE)