diff --git a/site/content/en/docs/Reference/Drivers/docker.md b/site/content/en/docs/Reference/Drivers/docker.md index f44261fbad..2fcd751123 100644 --- a/site/content/en/docs/Reference/Drivers/docker.md +++ b/site/content/en/docs/Reference/Drivers/docker.md @@ -4,28 +4,19 @@ linkTitle: "docker" weight: 3 date: 2020-02-05 description: > - Docker driver (EXPERIMENTAL) + Docker driver --- ## Overview -The Docker driver is an experimental VM-free driver that ships with minikube v1.7. +The Docker driver is a VM-free driver. + +{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}} -This driver was inspired by the [kind project](https://kind.sigs.k8s.io/), and uses a modified version of its base image. ## Special features -No hypervisor required when run on Linux. +- Cross platform (linux, macos, windows) +- No hypervisor required when run on Linux. -## Limitations -As an experimental driver, not all commands are supported on all platforms. Notably: `mount,` `service`, `tunnel`, and others. Most of these limitations will be addressed by minikube v1.8 (March 2020) - -## Issues - -* [Full list of open 'kic-driver' issues](https://github.com/kubernetes/minikube/labels/co%2Fkic-driver) - -## Troubleshooting - -* Run `minikube start --alsologtostderr -v=1` to debug crashes -* If your docker is too slow on mac os try [Improving docker performance](https://docs.docker.com/docker-for-mac/osxfs-caching/) diff --git a/site/content/en/docs/Reference/Drivers/hyperv.md b/site/content/en/docs/Reference/Drivers/hyperv.md index 909f1e03f8..3595a2bb9d 100644 --- a/site/content/en/docs/Reference/Drivers/hyperv.md +++ b/site/content/en/docs/Reference/Drivers/hyperv.md @@ -7,7 +7,6 @@ date: 2018-08-05 description: > Microsoft Hyper-V driver --- - ## Overview Hyper-V is a native hypervisor built in to modern versions of Microsoft Windows. diff --git a/site/content/en/docs/Reference/Drivers/includes/check_baremetal.inc b/site/content/en/docs/Reference/Drivers/includes/check_baremetal.inc new file mode 100644 index 0000000000..da6797ff8c --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/check_baremetal.inc @@ -0,0 +1,7 @@ +To use baremetal driver (none driver). verify that your operating system is Linux and also have 'systemd' installed. + +```shell +pidof systemd && echo "yes" || echo "no" +``` +If the above command outputs "no": +Your system is not suitable for none driver. \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/check_container.inc b/site/content/en/docs/Reference/Drivers/includes/check_container.inc new file mode 100644 index 0000000000..c189d8a2ac --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/check_container.inc @@ -0,0 +1,9 @@ +To use container drivers, verify that your system has either have 'docker' or 'podman' installed. +```shell +docker version +``` +or + +```shell +podman version +``` \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/check_virtualization_linux.inc b/site/content/en/docs/Reference/Drivers/includes/check_virtualization_linux.inc new file mode 100644 index 0000000000..3f60068016 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/check_virtualization_linux.inc @@ -0,0 +1,11 @@ +To use VM drivers, verify that your system has virtualization support enabled: + +```shell +egrep -q 'vmx|svm' /proc/cpuinfo && echo yes || echo no +``` + +If the above command outputs "no": + +- If you are running within a VM, your hypervisor does not allow nested virtualization. You will need to use the *None (bare-metal)* driver +- If you are running on a physical machine, ensure that your BIOS has hardware virtualization enabled + diff --git a/site/content/en/docs/Reference/Drivers/includes/check_virtualization_windows.inc b/site/content/en/docs/Reference/Drivers/includes/check_virtualization_windows.inc new file mode 100644 index 0000000000..14812b61ec --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/check_virtualization_windows.inc @@ -0,0 +1,19 @@ +To check if virtualization is supported, run the following command on your Windows terminal or command prompt. + +```shell +systeminfo +``` +If you see the following output, virtualization is supported: + +```shell +Hyper-V Requirements: VM Monitor Mode Extensions: Yes + Virtualization Enabled In Firmware: Yes + Second Level Address Translation: Yes + Data Execution Prevention Available: Yes +``` + +If you see the following output, your system already has a Hypervisor installed and you can skip the next step. + +```shell +Hyper-V Requirements: A hypervisor has been detected. +``` \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/docker_usage.inc b/site/content/en/docs/Reference/Drivers/includes/docker_usage.inc new file mode 100644 index 0000000000..df96d517ec --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/docker_usage.inc @@ -0,0 +1,16 @@ +## Install Docker + +- [Docker Desktop](https://hub.docker.com/search?q=&type=edition&offering=community&sort=updated_at&order=desc) + +## Usage + +Start a cluster using the docker driver: + +```shell +minikube start --driver=docker +``` +To make docker the default driver: + +```shell +minikube config set driver docker +``` diff --git a/site/content/en/docs/Reference/Drivers/kvm2.md b/site/content/en/docs/Reference/Drivers/kvm2.md index df13a3f95d..7e7c80a081 100644 --- a/site/content/en/docs/Reference/Drivers/kvm2.md +++ b/site/content/en/docs/Reference/Drivers/kvm2.md @@ -8,12 +8,17 @@ description: > Linux KVM (Kernel-based Virtual Machine) driver --- + ## Overview [KVM (Kernel-based Virtual Machine)](https://www.linux-kvm.org/page/Main_Page) is a full virtualization solution for Linux on x86 hardware containing virtualization extensions. To work with KVM, minikube uses the [libvirt virtualization API](https://libvirt.org/) {{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}} +## Check virtualization support + +{{% readfile file="/docs/Reference/Drivers/includes/virtualization_check_linux.inc" %}} + ## Special features The `minikube start` command supports 3 additional kvm specific flags: diff --git a/site/content/en/docs/Start/linux.md b/site/content/en/docs/Start/linux.md index b52b1690d8..8534cff5e2 100644 --- a/site/content/en/docs/Start/linux.md +++ b/site/content/en/docs/Start/linux.md @@ -39,28 +39,32 @@ curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-{{< la {{% /tab %}} {{% /tabs %}} -## Hypervisor Setup - -Verify that your system has virtualization support enabled: - -```shell -egrep -q 'vmx|svm' /proc/cpuinfo && echo yes || echo no -``` - -If the above command outputs "no": - -- If you are running within a VM, your hypervisor does not allow nested virtualization. You will need to use the *None (bare-metal)* driver -- If you are running on a physical machine, ensure that your BIOS has hardware virtualization enabled +## Driver Setup {{% tabs %}} +{{% tab "Docker" %}} +## Check container support +{{% readfile file="/docs/Reference/Drivers/includes/check_container.inc" %}} + +{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}} +{{% /tab %}} {{% tab "KVM" %}} +## Check virtualization support +{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_linux.inc" %}} + {{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}} {{% /tab %}} {{% tab "VirtualBox" %}} +## Check virtualization support +{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_linux.inc" %}} + {{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}} {{% /tab %}} {{% tab "None (bare-metal)" %}} +## Check baremetal support +{{% readfile file="/docs/Reference/Drivers/includes/check_baremetal_linux.inc" %}} + If you are already running minikube from inside a VM, it is possible to skip the creation of an additional VM layer by using the `none` driver. {{% readfile file="/docs/Reference/Drivers/includes/none_usage.inc" %}} diff --git a/site/content/en/docs/Start/macos.md b/site/content/en/docs/Start/macos.md index 3c41e3a9b9..1051d8a1a1 100644 --- a/site/content/en/docs/Start/macos.md +++ b/site/content/en/docs/Start/macos.md @@ -50,6 +50,9 @@ brew upgrade minikube ## Hypervisor Setup {{% tabs %}} +{{% tab "Docker" %}} +{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}} +{{% /tab %}} {{% tab "Hyperkit" %}} {{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.inc" %}} {{% /tab %}} diff --git a/site/content/en/docs/Start/windows.md b/site/content/en/docs/Start/windows.md index 02ff403f99..2fe1d79a5f 100644 --- a/site/content/en/docs/Start/windows.md +++ b/site/content/en/docs/Start/windows.md @@ -7,8 +7,6 @@ weight: 3 ### Prerequisites * Windows 8 or above -* A hypervisor, such as Hyper-V or VirtualBox -* Hardware virtualization support must be enabled in BIOS * 4GB of RAM ### Installation @@ -30,33 +28,23 @@ After it has installed, close the current CLI session and reopen it. minikube sh {{% /tab %}} {{% /tabs %}} -## Hypervisor Setup -To check if virtualization is supported, run the following command on your Windows terminal or command prompt. - -```shell -systeminfo -``` -If you see the following output, virtualization is supported: - -```shell -Hyper-V Requirements: VM Monitor Mode Extensions: Yes - Virtualization Enabled In Firmware: Yes - Second Level Address Translation: Yes - Data Execution Prevention Available: Yes -``` - -If you see the following output, your system already has a Hypervisor installed and you can skip the next step. - -```shell -Hyper-V Requirements: A hypervisor has been detected. -``` {{% tabs %}} +{{% tab "Docker" %}} +{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}} +{{% /tab %}} + {{% tab "Hyper-V" %}} +## Check Hypervisor +{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_windows.inc" %}} + {{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.inc" %}} {{% /tab %}} {{% tab "VirtualBox" %}} +## Check Hypervisor +{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_windows.inc" %}} + {{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}} {{% /tab %}} {{% /tabs %}}