minikube/docs/drivers.md

# Driver plugin installation

Minikube uses Docker Machine to manage the Kubernetes VM so it benefits from the
driver plugin architecture that Docker Machine uses to provide a consistent way to
manage various VM providers. Minikube embeds VirtualBox and VMware Fusion drivers
so there are no additional steps to use them. However, other drivers require an
extra binary to be present in the host PATH.

The following drivers currently require driver plugin binaries to be present in
the host PATH:

* [KVM](#kvm-driver)
* [xhyve](#xhyve-driver)
* [HyperV](#HyperV-driver)

#### KVM driver

Minikube is currently tested against [`docker-machine-driver-kvm` v0.10.0](https://github.com/dhiltgen/docker-machine-kvm/releases).

After following the instructions on the KVM driver releases page, you need to make sure that have the necessary packages and permissions by following these instructions:
```

# Install libvirt and qemu-kvm on your system, e.g.
# Debian/Ubuntu
$ sudo apt install libvirt-bin qemu-kvm
# Fedora/CentOS/RHEL
$ sudo yum install libvirt-daemon-kvm kvm

# Add yourself to the libvirtd group (use libvirt group for rpm based distros) so you don't need to sudo
# Debian/Ubuntu (NOTE: For Ubuntu 17.04 change the group to `libvirt`)
$ sudo usermod -a -G libvirtd $(whoami)
# Fedora/CentOS/RHEL
$ sudo usermod -a -G libvirt $(whoami)

# Update your current session for the group change to take effect
# Debian/Ubuntu (NOTE: For Ubuntu 17.04 change the group to `libvirt`)
$ newgrp libvirtd
# Fedora/CentOS/RHEL
$ newgrp libvirt
```

#### xhyve driver

From https://github.com/zchee/docker-machine-driver-xhyve#install:

```
$ brew install docker-machine-driver-xhyve

# docker-machine-driver-xhyve need root owner and uid
$ sudo chown root:wheel $(brew --prefix)/opt/docker-machine-driver-xhyve/bin/docker-machine-driver-xhyve
$ sudo chmod u+s $(brew --prefix)/opt/docker-machine-driver-xhyve/bin/docker-machine-driver-xhyve
```

#### HyperV driver

Hyper-v users may need to create a new external network switch as described [here](https://docs.docker.com/machine/drivers/hyper-v/). This step may prevent a problem in which `minikube start` hangs indefinitely, unable to ssh into the minikube virtual machine. In this add, add the `--hyperv-virtual-switch=switch-name` argument to the `minikube start` command.
Add xhyve driver support 2016-06-30 21:06:27 +00:00			`# Driver plugin installation`

			`Minikube uses Docker Machine to manage the Kubernetes VM so it benefits from the`
			`driver plugin architecture that Docker Machine uses to provide a consistent way to`
			`manage various VM providers. Minikube embeds VirtualBox and VMware Fusion drivers`
			`so there are no additional steps to use them. However, other drivers require an`
			`extra binary to be present in the host PATH.`

			`The following drivers currently require driver plugin binaries to be present in`
			`the host PATH:`

			`* [KVM](#kvm-driver)`
			`* [xhyve](#xhyve-driver)`
Add the HyperV-driver link. (#1351) * Add the HyperV-driver link. * Add the HyperV-driver link. 2017-04-10 14:57:42 +00:00			`* [HyperV](#HyperV-driver)`
Add xhyve driver support 2016-06-30 21:06:27 +00:00
			`#### KVM driver`

Update kvm driver version in readme 2017-05-01 18:17:24 +00:00			Minikube is currently tested against [`docker-machine-driver-kvm` v0.10.0](https://github.com/dhiltgen/docker-machine-kvm/releases).
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00
Update kvm driver version in readme 2017-05-01 18:17:24 +00:00			`After following the instructions on the KVM driver releases page, you need to make sure that have the necessary packages and permissions by following these instructions:`
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			```
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors 2017-05-03 21:53:51 +00:00
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			`# Install libvirt and qemu-kvm on your system, e.g.`
Added info for using KVM driver on Fedora :tophat: 2016-11-18 06:13:33 +00:00			`# Debian/Ubuntu`
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			`$ sudo apt install libvirt-bin qemu-kvm`
Added info for using KVM driver on Fedora :tophat: 2016-11-18 06:13:33 +00:00			`# Fedora/CentOS/RHEL`
			`$ sudo yum install libvirt-daemon-kvm kvm`
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00
Added info for using KVM driver on Fedora :tophat: 2016-11-18 06:13:33 +00:00			`# Add yourself to the libvirtd group (use libvirt group for rpm based distros) so you don't need to sudo`
Document how to use KVM on Ubuntu 17.04 2017-06-05 13:04:07 +00:00			# Debian/Ubuntu (NOTE: For Ubuntu 17.04 change the group to `libvirt`)
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			`$ sudo usermod -a -G libvirtd $(whoami)`
libvirt group for Fedora/CentOS/RHEL 2017-02-26 12:30:31 +00:00			`# Fedora/CentOS/RHEL`
			`$ sudo usermod -a -G libvirt $(whoami)`
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00
			`# Update your current session for the group change to take effect`
Document how to use KVM on Ubuntu 17.04 2017-06-05 13:04:07 +00:00			# Debian/Ubuntu (NOTE: For Ubuntu 17.04 change the group to `libvirt`)
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			`$ newgrp libvirtd`
libvirt group for Fedora/CentOS/RHEL 2017-02-26 12:30:31 +00:00			`# Fedora/CentOS/RHEL`
			`$ newgrp libvirt`
Add more detailed instructions for the kvm driver Users must properly install and configure libvirt + qemu Solves issues such as #278 2016-07-13 10:40:24 +00:00			```
Add xhyve driver support 2016-06-30 21:06:27 +00:00
			`#### xhyve driver`

			`From https://github.com/zchee/docker-machine-driver-xhyve#install:`

			```
			`$ brew install docker-machine-driver-xhyve`

			`# docker-machine-driver-xhyve need root owner and uid`
			`$ sudo chown root:wheel $(brew --prefix)/opt/docker-machine-driver-xhyve/bin/docker-machine-driver-xhyve`
			`$ sudo chmod u+s $(brew --prefix)/opt/docker-machine-driver-xhyve/bin/docker-machine-driver-xhyve`
			```
Add the HyperV-driver link. (#1351) * Add the HyperV-driver link. * Add the HyperV-driver link. 2017-04-10 14:57:42 +00:00
Update kubectl installation instructions Move hyper-v warning to Known issues. 2016-12-13 18:56:21 +00:00			`#### HyperV driver`

Add the HyperV-driver link. (#1351) * Add the HyperV-driver link. * Add the HyperV-driver link. 2017-04-10 14:57:42 +00:00			Hyper-v users may need to create a new external network switch as described [here](https://docs.docker.com/machine/drivers/hyper-v/). This step may prevent a problem in which `minikube start` hangs indefinitely, unable to ssh into the minikube virtual machine. In this add, add the `--hyperv-virtual-switch=switch-name` argument to the `minikube start` command.