diff --git a/README.md b/README.md index bd768550a8cf..a31ca560bfb0 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ We also released a Debian package and Windows installer on our [releases page](h ### Requirements * [kubectl](https://kubernetes.io/docs/tasks/kubectl/install/) * macOS - * [xhyve driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#xhyve-driver), [VirtualBox](https://www.virtualbox.org/wiki/Downloads), or [VMware Fusion](https://www.vmware.com/products/fusion) + * [Hyperkit driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver), [xhyve driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#xhyve-driver), [VirtualBox](https://www.virtualbox.org/wiki/Downloads), or [VMware Fusion](https://www.vmware.com/products/fusion) * Linux * [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or [KVM](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm-driver) * **NOTE:** Minikube also supports a `--vm-driver=none` option that runs the Kubernetes components on the host and not in a VM. Docker is required to use this driver but no hypervisor. @@ -93,6 +93,7 @@ the following drivers: * virtualbox * vmwarefusion * [KVM](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm-driver) +* [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) * [xhyve](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#xhyve-driver) * [Hyper-V](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperV-driver) * none (**Linux-only**) - this driver can be used to run the Kubernetes cluster components on the host instead of in a VM. This can be useful for CI workloads which do not support nested virtualization. diff --git a/docs/drivers.md b/docs/drivers.md index 57c14c2bb934..96891a1af2b6 100644 --- a/docs/drivers.md +++ b/docs/drivers.md @@ -10,6 +10,7 @@ The following drivers currently require driver plugin binaries to be present in the host PATH: * [KVM](#kvm-driver) +* [Hyperkit](#hyperkit-driver) * [xhyve](#xhyve-driver) * [HyperV](#hyperv-driver) @@ -39,6 +40,19 @@ $ newgrp libvirtd $ newgrp libvirt ``` +#### Hyperkit driver + +The Hyperkit driver will eventually replace the existing xhyve driver. +It is built from the minikube source tree, and uses [moby/hyperkit](http://github.com/moby/hyperkit) as a Go library. + +To install the hyperkit driver: + +``` +curl -Lo https://storage.googleapis.com/releases/latest/docker-machine-driver-xhyve && chmod +x docker-machine-driver-xhyve && sudo mv docker-machine-driver-xhyve /usr/local/bin/ && sudo chown root:wheel /usr/local/bin/docker-machine-driver-xhyve && sudo chmod u+s /usr/local/bin/docker-machine-driver-xhyve +``` + +The hyperkit driver currently requires running as root to use the vmnet framework to setup networking. + #### xhyve driver From https://github.com/zchee/docker-machine-driver-xhyve#install: