diff --git a/site/content/en/docs/Getting started/includes/virtualbox.md b/site/content/en/docs/Getting started/includes/virtualbox.md deleted file mode 100644 index 9f2c51c55f..0000000000 --- a/site/content/en/docs/Getting started/includes/virtualbox.md +++ /dev/null @@ -1,7 +0,0 @@ -Download and install the latest version of VirtualBox from https://www.virtualbox.org/ - -Once installed, start minikube: - -```shell -minikube start -``` diff --git a/site/content/en/docs/Getting started/linux.md b/site/content/en/docs/Getting started/linux.md index aed5bac238..19cd96089f 100644 --- a/site/content/en/docs/Getting started/linux.md +++ b/site/content/en/docs/Getting started/linux.md @@ -55,44 +55,15 @@ If the above command outputs "no": {{% tabs %}} {{% tab "VirtualBox" %}} -{{% readfile file="/docs/Getting started/includes/virtualbox.md" %}} +{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}} {{% /tab %}} {{% tab "KVM" %}} - -### Prerequisites Installation - -{{% readfile file="/docs/Reference/Drivers/includes/kvm2_prereqs_install.md" %}} - -### Driver Installation - -{{% readfile file="/docs/Reference/Drivers/includes/kvm2_driver_install.md" %}} - -### Usage - -```shell -minikube start --vm-driver=kvm2 -``` -To make kvm2 the default for future invocations, run: - -```shell -minikube config set vm-driver kvm2 -``` - +{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.md" %}} {{% /tab %}} {{% tab "None (bare-metal)" %}} +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. -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. -This mode does come with additional requirements: - -- docker -- systemd -- sudo access - -```shell -sudo minikube start --vm-driver=none -``` - -Please see the [docs/reference/drivers/none](none driver) documentation for more information. +{{% readfile file="/docs/Reference/Drivers/includes/none_usage.md" %}} {{% /tab %}} {{% /tabs %}} diff --git a/site/content/en/docs/Getting started/macos.md b/site/content/en/docs/Getting started/macos.md index a08efe5b88..2f51c89143 100644 --- a/site/content/en/docs/Getting started/macos.md +++ b/site/content/en/docs/Getting started/macos.md @@ -14,7 +14,7 @@ weight: 2 {{% tabs %}} {{% tab "Brew" %}} -If you have the [Brew Package Manager](https://brew.sh/) installed, this will download and install minikube to /usr/local/bin: +If the [Brew Package Manager](https://brew.sh/) is installed, use it to download and install minikube: ```shell brew install minikube @@ -30,68 +30,22 @@ curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin && sudo install minikube-darwin-amd64 /usr/local/bin/minikube ``` {{% /tab %}} - {{% /tabs %}} ## Hypervisor Setup {{% tabs %}} {{% tab "VirtualBox" %}} -{{% readfile file="/docs/Getting started/includes/virtualbox.md" %}} +{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}} {{% /tab %}} {{% tab "Hyperkit" %}} - - -### Prerequisites Installation - -{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_prereqs_install.md" %}} - -### Driver Installation - -{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_driver_install.md" %}} - -### Usage - -```shell -minikube start --vm-driver=hyperkit -``` - -To make hyperkit the default for future invocations: - -```shell -minikube config set vm-driver hyperkit -``` - +{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.md" %}} {{% /tab %}} - {{% tab "Parallels" %}} - -Start minikube with Parallels support using: - -```shell -minikube start --vm-driver=parallels -``` - -To make parallels the default for future invocations: - -```shell -minikube config set vm-driver parallels -``` +{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.md" %}} {{% /tab %}} - -{{% tab "VMware Fusion" %}} - -Start minikube with VMware Fusion support using: - -```shell -minikube start --vm-driver=vmwarefusion -``` - -To make vmwarefusion the default for future invocations: - -```shell -minikube config set vm-driver vmwarefusion -``` +{{% tab "VMware" %}} +{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.md" %}} {{% /tab %}} {{% /tabs %}} diff --git a/site/content/en/docs/Getting started/windows.md b/site/content/en/docs/Getting started/windows.md index 4cc0040162..747a8004d5 100644 --- a/site/content/en/docs/Getting started/windows.md +++ b/site/content/en/docs/Getting started/windows.md @@ -15,12 +15,12 @@ weight: 3 {{% tabs %}} {{% tab "Direct" %}} -Download and run the [installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe) +Download and run the [minikube installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe) {{% /tab %}} {{% tab "Chocolatey" %}} -If you have the [Chocolatey Package Manager](https://chocolatey.org/) installed, you can install minikube if run as an Administrator: +If the [Chocolatey Package Manager](https://chocolatey.org/) is installed, use it to install minikube: ```shell choco install minikube @@ -55,24 +55,10 @@ Hyper-V Requirements: A hypervisor has been detected. {{% tabs %}} {{% tab "VirtualBox" %}} -{{% readfile file="/docs/Getting started/includes/virtualbox.md" %}} +{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}} {{% /tab %}} {{% tab "Hyper-V" %}} - -If Hyper-V is active, you can start minikube with Hyper-V support using: - -```shell -minikube start --vm-driver=hyperv -``` - -NOTE: If this fails due to networking issues, see the [Hyper-V driver documentation](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyper-v-driver) for further instructions. - -To make hyperv the default for future invocations: - -```shell -minikube config set vm-driver hyperv -``` - +{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.md" %}} {{% /tab %}} {{% /tabs %}} diff --git a/site/content/en/docs/Reference/Drivers/hyperkit.md b/site/content/en/docs/Reference/Drivers/hyperkit.md index 589195a2e7..2cba901305 100644 --- a/site/content/en/docs/Reference/Drivers/hyperkit.md +++ b/site/content/en/docs/Reference/Drivers/hyperkit.md @@ -1,6 +1,6 @@ --- -title: "HyperKit" -linkTitle: "HyperKit" +title: "hyperkit" +linkTitle: "hyperkit" weight: 1 date: 2018-08-08 description: > @@ -11,29 +11,7 @@ description: > [HyperKit](https://github.com/moby/hyperkit) is an open-source hypervisor for macOS hypervisor, optimized for lightweight virtual machines and container deployment. -## Requirements - -- macOS High Sierra 10.12 (or newer) -- HyperKit - -## Installing Prerequisites - -{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_prereqs_install.md" %}} - -## Driver installation - -{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_driver_install.md" %}} - -## Usage - -```shell -minikube start --vm-driver=hyperkit -``` -To make hyperkit the default driver: - -```shell -minikube config set vm-driver hyperkit -``` +{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.md" %}} ## Special features diff --git a/site/content/en/docs/Reference/Drivers/hyperv.md b/site/content/en/docs/Reference/Drivers/hyperv.md new file mode 100644 index 0000000000..f075cbe39e --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/hyperv.md @@ -0,0 +1,29 @@ +--- +title: "hyperv" +linkTitle: "hyperv" +weight: 2 +date: 2017-01-05 +date: 2018-08-05 +description: > + Microsoft Hyper-V driver +--- + +## Overview + +Hyper-V is a native hypervisor built in to modern versions of Microsoft Windows. + +{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.md" %}} + +## Special features + +The `minikube start` command supports 3 additional hyperv specific flags: + +* **\--hyperv-virtual-switch**: The hyperv virtual switch name. Defaults to first found + +## Issues + +Also see [co/hyperv open issues](https://github.com/kubernetes/minikube/labels/co%2Fhyperv) + +## Troubleshooting + +* Run `minikube start --alsologtostderr -v=7` to debug crashes diff --git a/site/content/en/docs/Reference/Drivers/includes/hyperkit_driver_install.md b/site/content/en/docs/Reference/Drivers/includes/hyperkit_driver_install.md deleted file mode 100644 index e413470b7b..0000000000 --- a/site/content/en/docs/Reference/Drivers/includes/hyperkit_driver_install.md +++ /dev/null @@ -1,7 +0,0 @@ -Download and install the latest minikube hyperkit driver: - -```shell -curl -LO https://storage.googleapis.com/minikube/releases/latest/ -docker-machine-driver-hyperkit \ -&& sudo install -o root -m 4755 docker-machine-driver-hyperkit /usr/local/bin/ -``` \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/hyperkit_prereqs_install.md b/site/content/en/docs/Reference/Drivers/includes/hyperkit_prereqs_install.md deleted file mode 100644 index 399aa5b3f8..0000000000 --- a/site/content/en/docs/Reference/Drivers/includes/hyperkit_prereqs_install.md +++ /dev/null @@ -1,7 +0,0 @@ -* If you have Docker for Desktop installed, you already have hyperkit installed. -* If you have the [Brew Package Manager](https://brew.sh/) installed, run: - -```shell -brew install hyperkit -``` -* To install HyperKit manually, see the [HyperKit on GitHub](https://github.com/moby/hyperkit) \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/hyperkit_usage.md b/site/content/en/docs/Reference/Drivers/includes/hyperkit_usage.md new file mode 100644 index 0000000000..3604c0fa95 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/hyperkit_usage.md @@ -0,0 +1,26 @@ +## Requirements + +- macOS 10.11+ +- HyperKit + +## Installing dependencies + +If Docker for Desktop is installed, HyperKit is already installed. + +Otherwise, if the [Brew Package Manager](https://brew.sh/) is installed: + +```shell +brew install hyperkit +``` + +As a final alternative, you can [Install HyperKit from GitHub](https://github.com/moby/hyperkit) + +## Driver Installation + +Download and install the latest minikube driver: + +```shell +curl -LO https://storage.googleapis.com/minikube/releases/latest/ +docker-machine-driver-hyperkit \ +&& sudo install -o root -m 4755 docker-machine-driver-hyperkit /usr/local/bin/ +``` \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md b/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md new file mode 100644 index 0000000000..a90c6c9640 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md @@ -0,0 +1,36 @@ +## Requirements + +* Windows 10 Pro +* Hyper-V enabled +* A Hyper-V switch created + +## Configuring Hyper-V + +Open a PowerShell console as Administrator, and run the following command: + +```powershell +Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All +``` + +Reboot, and create a new external network switch: + +```powershell +New-VMSwitch -name ExternalSwitch -NetAdapterName Ethernet -AllowManagementOS $true +``` + +Set this network switch as the minikube default: + +```shell +minikube config set hyperv-virtual-switch ExternalSwitch +``` + +## Usage + +```shell +minikube start --vm-driver=hyperv +``` +To make hyperv the default driver: + +```shell +minikube config set vm-driver hyperv +``` diff --git a/site/content/en/docs/Reference/Drivers/includes/kvm2_driver_install.md b/site/content/en/docs/Reference/Drivers/includes/kvm2_driver_install.md deleted file mode 100644 index 6b56ee16c4..0000000000 --- a/site/content/en/docs/Reference/Drivers/includes/kvm2_driver_install.md +++ /dev/null @@ -1,4 +0,0 @@ -```shell - curl -LO https://storage.googleapis.com/minikube/releases/latest/docker-machine-driver-kvm2 \ - && sudo install docker-machine-driver-kvm2 /usr/local/bin/ -``` diff --git a/site/content/en/docs/Reference/Drivers/includes/kvm2_prereqs_install.md b/site/content/en/docs/Reference/Drivers/includes/kvm2_usage.md similarity index 71% rename from site/content/en/docs/Reference/Drivers/includes/kvm2_prereqs_install.md rename to site/content/en/docs/Reference/Drivers/includes/kvm2_usage.md index 3557772635..2be6136a17 100644 --- a/site/content/en/docs/Reference/Drivers/includes/kvm2_prereqs_install.md +++ b/site/content/en/docs/Reference/Drivers/includes/kvm2_usage.md @@ -1,3 +1,10 @@ +## Requirements + +- libvirt v1.3.1 or higher +- qemu-kvm v2.0 or higher + +## Installing Prerequisites + Proper installation of KVM and libvirt is highly specific to each Linux distribution. Please consult: * [ArchLinux](https://wiki.archlinux.org/index.php/Libvirt) @@ -13,3 +20,10 @@ Once configured, validate that libvirt reports no errors: ```shell virt-host-validate ``` + +## Driver installation + +```shell + curl -LO https://storage.googleapis.com/minikube/releases/latest/docker-machine-driver-kvm2 \ + && sudo install docker-machine-driver-kvm2 /usr/local/bin/ +``` diff --git a/site/content/en/docs/Reference/Drivers/includes/none_usage.md b/site/content/en/docs/Reference/Drivers/includes/none_usage.md new file mode 100644 index 0000000000..d6893edd5c --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/none_usage.md @@ -0,0 +1,17 @@ +## Requirements + +VM running a systemd-based Linux distribution ([see #2704](https://github.com/kubernetes/minikube/issues/2704)) + +## Usage + +The none driver requires minikube to be run as root, until [#3760](https://github.com/kubernetes/minikube/issues/3760) can be addressed. + +```shell +sudo minikube start --vm-driver=none +``` + +To make none the default for future invocations, run: + +```shell +sudo minikube config set vm-driver none +``` diff --git a/site/content/en/docs/Reference/Drivers/includes/parallels_usage.md b/site/content/en/docs/Reference/Drivers/includes/parallels_usage.md new file mode 100644 index 0000000000..831e119d65 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/parallels_usage.md @@ -0,0 +1,19 @@ +## Requirements + +* Parallels Desktop 11.0.0+ Pro or Business edition + +## Driver Installation + +If the [Brew Package Manager](https://brew.sh/) is installed, run: + +``` +brew install docker-machine-driver-parallels +``` + +Otherwise: + +```shell +r=https://api.github.com/repos/Parallels/docker-machine-parallels +curl -LO $(curl -s $r/releases/latest | grep -o 'http.*parallels' | head -n1) \ + && install docker-machine-driver-parallels /usr/local/bin/ +``` diff --git a/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md b/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md new file mode 100644 index 0000000000..148dc7b745 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md @@ -0,0 +1,16 @@ +## Requirements + +- [https://www.virtualbox.org/wiki/Downloads](VirtualBox) 5.2 or higher + +## Usage + +minikube currently uses VirtualBox by default, but it can also be explicitly set: + +```shell +minikube start --vm-driver=virtualbox +``` +To make virtualbox the default driver: + +```shell +minikube config set vm-driver virtualbox +``` diff --git a/site/content/en/docs/Reference/Drivers/includes/vmware_macos_usage.md b/site/content/en/docs/Reference/Drivers/includes/vmware_macos_usage.md new file mode 100644 index 0000000000..5048b256d7 --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/includes/vmware_macos_usage.md @@ -0,0 +1,31 @@ +## Requirements + +* VMware Fusion + +## Driver Installation + +If the [Brew Package Manager](https://brew.sh/) is installed, run: + +``` +brew install docker-machine-driver-vmware +``` + +Otherwise: + +```shell +r=https://api.github.com/repos/machine-drivers/docker-machine-driver-vmware +curl -LO $(curl -s $r/releases/latest | grep -o 'http.*darwin_amd64' | head -n1) \ + && install docker-machine-driver-vmware_darwin_amd64 \ + /usr/local/bin/docker-machine-driver-vmware +``` + +## Usage + +```shell +minikube start --vm-driver=vmware +``` +To make vmware the default driver: + +```shell +minikube config set vm-driver vmware +``` \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/kvm2.md b/site/content/en/docs/Reference/Drivers/kvm2.md index d4d58b6c0a..e5da5b34ff 100644 --- a/site/content/en/docs/Reference/Drivers/kvm2.md +++ b/site/content/en/docs/Reference/Drivers/kvm2.md @@ -1,7 +1,7 @@ --- title: "kvm2" linkTitle: "kvm2" -weight: 1 +weight: 2 date: 2017-01-05 date: 2018-08-05 description: > @@ -12,29 +12,7 @@ description: > [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/) -## Requirements - -- libvirt v1.3.1 or higher -- qemu-kvm v2.0 or higher - -## Installing Prerequisites - -{{% readfile file="/docs/Reference/Drivers/includes/kvm2_prereqs_install.md" %}} - -## Driver installation - -{{% readfile file="/docs/Reference/Drivers/includes/kvm2_driver_install.md" %}} - -## Usage - -```shell -minikube start --vm-driver=kvm2 -``` -To make kvm2 the default for future invocations, run: - -```shell -minikube config set vm-driver kvm2 -``` +{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.md" %}} ## Special features diff --git a/site/content/en/docs/Reference/Drivers/none.md b/site/content/en/docs/Reference/Drivers/none.md index 9ad00d786f..38c4b4fa65 100644 --- a/site/content/en/docs/Reference/Drivers/none.md +++ b/site/content/en/docs/Reference/Drivers/none.md @@ -1,7 +1,7 @@ --- title: "none" linkTitle: "none" -weight: 1 +weight: 3 date: 2017-01-05 date: 2018-08-05 description: > @@ -12,28 +12,7 @@ description: > This document is written for system integrators who are familiar with minikube, and wish to run it within a customized VM environment. The `none` driver allows advanced minikube users to skip VM creation, allowing minikube to be run on a user-supplied VM. -## Features - -* Ability to run without the creation of an additional VM -* Fast setup and teardown - -## Requirements - -VM running a systemd-based Linux distribution ([see #2704](https://github.com/kubernetes/minikube/issues/2704)) - -## Usage - -The none driver requires minikube to be run as root, until [#3760](https://github.com/kubernetes/minikube/issues/3760) can be addressed. - -```shell -sudo minikube start --vm-driver=none -``` - -To make none the default for future invocations, run: - -```shell -sudo minikube config set vm-driver none -``` +{{% readfile file="/docs/Reference/Drivers/includes/none_usage.md" %}} ## Issues diff --git a/site/content/en/docs/Reference/Drivers/parallels.md b/site/content/en/docs/Reference/Drivers/parallels.md new file mode 100644 index 0000000000..e1458be93f --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/parallels.md @@ -0,0 +1,23 @@ +--- +title: "parallels" +linkTitle: "parallels" +weight: 4 +date: 2018-08-08 +description: > + Parallels driver +--- + +## Overview + +The Parallels driver is particularly useful for users who own Parallels Desktop, as it does not require VT-x hardware support. + +{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.md" %}} + +## Issues + +* [Full list of open 'parallels' driver issues](https://github.com/kubernetes/minikube/labels/co%2Fparallels) + +## Troubleshooting + +* Run `minikube start --alsologtostderr -v=7` to debug crashes +* \ No newline at end of file diff --git a/site/content/en/docs/Reference/Drivers/virtualbox.md b/site/content/en/docs/Reference/Drivers/virtualbox.md index 4f0e519f98..4303387eb1 100644 --- a/site/content/en/docs/Reference/Drivers/virtualbox.md +++ b/site/content/en/docs/Reference/Drivers/virtualbox.md @@ -1,7 +1,7 @@ --- -title: "VirtualBox" -linkTitle: "VirtualBox" -weight: 1 +title: "virtualbox" +linkTitle: "virtualbox" +weight: 5 date: 2018-08-08 description: > VirtualBox driver @@ -11,23 +11,7 @@ description: > VirtualBox is the oldest and most stable VM driver for minikube. - -## Requirements - -- [https://www.virtualbox.org/wiki/Downloads](VirtualBox) 5.2 or higher - -## Usage - -minikube currently uses VirtualBox by default, but it can also be explicitly set: - -```shell -minikube start --vm-driver=virtualbox -``` -To make virtualbox the default driver: - -```shell -minikube config set vm-driver virtualbox -``` +{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}} ## Special features diff --git a/site/content/en/docs/Reference/Drivers/vmware.md b/site/content/en/docs/Reference/Drivers/vmware.md new file mode 100644 index 0000000000..604e1d0a3a --- /dev/null +++ b/site/content/en/docs/Reference/Drivers/vmware.md @@ -0,0 +1,32 @@ +--- +title: "vmware" +linkTitle: "vmware" +weight: 6 +date: 2018-08-08 +description: > + VMware driver +--- + +## Overview + +The vmware driver supports virtualization across all VMware based hypervisors. + +{{% tabs %}} +{{% tab "macOS" %}} +{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.md" %}} +{{% /tab %}} +{{% tab "Linux" %}} +No documentation is available yet. +{{% /tab %}} +{{% tab "Windows" %}} +No documentation is available yet. +{{% /tab %}} +{{% /tabs %}} + +## Issues + +* [Full list of open 'vmware' driver issues](https://github.com/kubernetes/minikube/labels/co%2Fvmware) + +## Troubleshooting + +* Run `minikube start --alsologtostderr -v=7` to debug crashes \ No newline at end of file