This project is not maintained anymore, please use minikube instead
Kube-Solo for macOS is a status bar App
which allows in an easy way to bootstrap and control Kubernetes cluster on a standalone CoreOS VM machine. VM can also be controlled via ksolo
cli. Also VM's docker
API is exposed to macOS, so you can build your docker images with the same app and use them with Kubernetes.
Kube-Solo for macOS is a similar app to minikube, just has more functionality and is an older project. You can run both Apps on your Mac even in parallel.
It leverages macOS native Hypervisor virtualisation framework of using corectl command line tool, so there are no needs to use VirtualBox or any other virtualisation software anymore.
Includes: Helm v2 - The Kubernetes Package Manager and an option from shell to install Deis Workflow PaaS on top of Kubernetes with a simple: $ install_deis
command.
App's menu looks as per image below:
Head over to the Releases Page to grab the latest release.
- macOS 10.10.3 Yosemite or later
- Mac 2010 or later for this to work.
- Note: Corectl App must be installed, which will serve as
corectld
server daemon control. - iTerm2 is required, if not found the app will install it by itself.
- libev
brew install libev
- Download Corectl App
latest dmg
from the Releases Page and install it to/Applications
folder, it allows to start/stop/update corectl tools needed to run CoreOS VMs on macOS - Open downloaded
dmg
file and drag the App e.g. to your Desktop. Start theKube-Solo
App andInitial setup of Kube-Solo VM
will run, then follow the instructions there.
TL;DR
- App's files are installed to
~/kube-solo
folder - App will bootstrap
master+worker
Kubernetes cluster on the single VM - Mac user home folder is automaticly mounted via NFS (it has to work on Mac end of course) to
/Users/my_user
:/Users/my_user
on each VM boot, check the PV example how to use Persistent Volumes. - macOS
docker
client is installed to~/kube-solo/bin
and preset inOS shell
to be used from there, so you can builddocker
images on the VM and use with Kubernetes - After successful install you can control
kube-solo
VM viaksolo
cli as well. Cli resides in~/kube-solo/bin
and~/bin
folders and has simple commands:ksolo start|stop|status|ip|ssh|shell
, just add~/bin
to your pre-set path.
The install will do the following:
- All dependent files/folders will be put under
~/kube-solo
folder in the user's home folder e.g/Users/someuser/kube-solo
. - Will download latest CoreOS ISO image (if there is no such one) and run
corectl
to initialise VM - When you first time do install or
Up
after destroying Kube-Solo setup, k8s binary files (with the version which was available when the App was built) get copied to VM, this allows to speed up Kubernetes setup. - It will install
docker, helm, deis and kubectl
clients to~/kube-solo/bin/
- Kubernetes Dashboard and DNS will be instlled as add-ons
- Via assigned static IP (it will be shown in first boot and will survive VM's reboots) you can access any port on CoreOS VM
- Persistent sparse disk (QCow2)
data.img
will be created and mounted to/data
for these mount binds and other folders:
/data/var/lib/docker -> /var/lib/docker
/data/var/lib/rkt -> /var/lib/rkt
/var/lib/kubelet sym linked to /data/kubelet
/data/opt/bin
/data/var/lib/etcd2
/data/kubernetes
Just start Kube-Solo
application and you will find a small icon of Kubernetes logo with S
in the Status Bar.
- There you can
Up
andHalt
k8solo-01 VM SSH to k8solo-01
will open VM shell- Under
Up
OS Shell will be opened after VM boots up and it will have such environment pre-set:
kubernetes master - export KUBERNETES_MASTER=http://192.168.64.xxx:8080
etcd endpoint - export ETCDCTL_PEERS=http://192.168.64.xxx:2379
DOCKER_HOST=tcp://192.168.64.xxx:2375
Path to `~/kube-solo/bin` where macOS clients and shell scripts are stored
ksolo start
will start k8solo-01 VM and shell environment will be pre-set as above.ksolo stop
will stop VMksolo status
will show VM's statusksolo ip
will show VM's IPksolo ssh
will ssh to VMksolo shell
will open pre-set shell
- Kubernetes Dashboard will show nice Kubernetes Dashboard, where you can check Nodes, Pods, Replication, Deployments, Service Controllers, deploy Apps and etc.
Check for App updates
will check for a new app versionUpdates/Update Kubernetes to the latest version
will update to latest version of Kubernetes.Updates/Change Kubernetes version
will download and install specified Kubernetes version from GitHub.Updates/Update macOS helm and deis clients
will updatehelm
anddeis
to the latest version.Setup/
will allow you to do:
- Change CoreOS Release Channel
- Change VM's RAM size
- Destroy Kube-Solo VM (just deletes data.img file)
- Initial setup of Kube-Solo VM
Example output of succesfull Kubernetes Solo install:
kubectl cluster-info:
Kubernetes master is running at http://192.168.64.3:8080
KubeDNS is running at http://192.168.64.3:8080/api/v1/proxy/namespaces/kube-system/services/kube-dns
kubernetes-dashboard is running at http://192.168.64.3:8080/api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard
Cluster version:
Client version: v1.5.1
Server version: v1.5.1
kubectl get nodes:
NAME STATUS AGE
k8solo-01 Ready 12s
You're now ready to use Kubernetes cluster.
Some examples to start with Kubernetes examples.
-
Kubernetes Cluster (master + 2 nodes) App - Kube-Cluster for OS X.
-
Standalone CoreOS VM App - CoreOS macOS.
-
CoreOS Cluster (control + 2 nodes) App - CoreOS-Vagrant Cluster.
Kube-Solo for macOS is an open source project release under the Apache License, Version 2.0, hence contributions and suggestions are gladly welcomed!