Skip to content

Commit

Permalink
Split minikube install task into tabs (per-OS) (kubernetes#14013)
Browse files Browse the repository at this point in the history
* Put minikube install steps in per-OS tabs

* Work around nested <li> formatting issue

Using Markdown unordered lists inside tabs doesn't seem to work. These
changes are my work-around for that.

* Reword "laptop" to personal computer

Some computers aren't laptops

* Drop trailing whitespace

* Drop warning about removing other Mac hypervisors
  • Loading branch information
sftim authored and k8s-ci-robot committed Jun 11, 2019
1 parent 7b44b7a commit 5c3e795
Showing 1 changed file with 73 additions and 37 deletions.
110 changes: 73 additions & 37 deletions content/en/docs/tasks/tools/install-minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,16 @@ card:

{{% capture overview %}}

This page shows you how to install [Minikube](/docs/tutorials/hello-minikube), a tool that runs a single-node Kubernetes cluster in a virtual machine on your laptop.
This page shows you how to install [Minikube](/docs/tutorials/hello-minikube), a tool that runs a single-node Kubernetes cluster in a virtual machine on your personal computer.

{{% /capture %}}

{{% capture prerequisites %}}

VT-x or AMD-v virtualization must be enabled in your computer's BIOS.

{{< tabs name="minikube_before_you_begin" >}}
{{% tab name="Linux" %}}
To check if virtualization is supported on Linux, run the following command and verify that the output is non-empty:
```
```shell
egrep --color 'vmx|svm' /proc/cpuinfo
```
{{% /tab %}}
Expand All @@ -32,7 +30,7 @@ sysctl -a | grep machdep.cpu.features
If you see `VMX` in the output, the VT-x feature is supported on your OS.
{{% /tab %}}
{{% tab name="Windows" %}}
To check if virtualization is supported on Windows 8 and above, run the following command on your Windows terminal or command prompt.
To check if virtualization is supported on Windows 8 and above, run the following command on your Windows terminal or command prompt.
```
systeminfo
```
Expand All @@ -57,35 +55,74 @@ Hyper-V Requirements: A hypervisor has been detected. Features required for

{{% capture steps %}}

## Install a Hypervisor
# Installing minikube

{{< tabs name="tab_with_md" >}}
{{% tab name="Linux" %}}

### Install kubectl

If you do not already have a hypervisor installed, install one for your OS now:
Make sure you have kubectl installed. You can install kubectl according to the instructions in [Install and Set Up kubectl](/docs/tasks/tools/install-kubectl/#install-kubectl-on-linux).

Operating system | Supported hypervisors
:----------------|:---------------------
macOS | [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [VMware Fusion](https://www.vmware.com/products/fusion), [HyperKit](https://github.com/moby/hyperkit)
Linux | [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [KVM](http://www.linux-kvm.org/)
Windows | [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [Hyper-V](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick_start/walkthrough_install)
### Install a Hypervisor

If you do not already have a hypervisor installed, install one of these now:

[KVM](https://www.linux-kvm.org/), which also uses QEMU

[VirtualBox](https://www.virtualbox.org/wiki/Downloads)

{{< note >}}
Minikube also supports a `--vm-driver=none` option that runs the Kubernetes components on the host and not in a VM. Using this driver requires Docker and a Linux environment but not a hypervisor.
Minikube also supports a `--vm-driver=none` option that runs the Kubernetes components on the host and not in a VM. Using this driver requires [Docker](https://www.docker.com/products/docker-desktop) and a Linux environment but not a hypervisor.
{{< /note >}}

## Install kubectl
### Install Minikube using a package

There are *experimental* packages for Minikube available; you can find Linux (AMD64) packages
from Minikube's [releases](https://github.com/kubernetes/minikube/releases) page on GitHub.

Use your Linux's distribution's package tool to install a suitable package.

### Install Minikube via direct download

If you're not installing via a package, you can download a stand-alone
binary and use that.

```shell
curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 \
&& chmod +x minikube
```

Here's an easy way to add the Minikube executable to your path:

```shell
sudo install minikube /usr/local/bin
```

{{% /tab %}}
{{% tab name="macOS" %}}
### Install kubectl

Make sure you have kubectl installed. You can install kubectl according to the instructions in [Install and Set Up kubectl](/docs/tasks/tools/install-kubectl/#install-kubectl-on-macos).

### Install a Hypervisor

If you do not already have a hypervisor installed, install one of these now:

* Install kubectl according to the instructions in [Install and Set Up kubectl](/docs/tasks/tools/install-kubectl/).
[HyperKit](https://github.com/moby/hyperkit)

## Install Minikube
[VirtualBox](https://www.virtualbox.org/wiki/Downloads)

### macOS
[VMware Fusion](https://www.vmware.com/products/fusion)

### Install Minikube
The easiest way to install Minikube on macOS is using [Homebrew](https://brew.sh):

```shell
brew cask install minikube
```

You can also install it on macOS by downloading a static binary:
You can also install it on macOS by downloading a stand-alone binary:

```shell
curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 \
Expand All @@ -98,31 +135,26 @@ Here's an easy way to add the Minikube executable to your path:
sudo mv minikube /usr/local/bin
```

### Linux
{{% /tab %}}
{{% tab name="Windows" %}}
### Install kubectl

{{< note >}}
This document shows you how to install Minikube on Linux using a static binary.
{{< /note >}}
Make sure you have kubectl installed. You can install kubectl according to the instructions in [Install and Set Up kubectl](/docs/tasks/tools/install-kubectl/#install-kubectl-on-windows).

You can install Minikube on Linux by downloading a static binary:
### Install a Hypervisor

```shell
curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 \
&& chmod +x minikube
```

Here's an easy way to add the Minikube executable to your path:
If you do not already have a hypervisor installed, install one of these now:

```shell
sudo cp minikube /usr/local/bin && rm minikube
```
[Hyper-V](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick_start/walkthrough_install)

### Windows
[VirtualBox](https://www.virtualbox.org/wiki/Downloads)

{{< note >}}
To run Minikube on Windows, you first need to install [VirtualBox](https://www.virtualbox.org/) or [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v). Hyper-V can be run on three versions of Windows 10: Windows 10 Enterprise, Windows 10 Professional, and Windows 10 Education. See the official Minikube GitHub repository for additional [installation information](https://github.com/kubernetes/minikube/#installation).
Hyper-V can run on three versions of Windows 10: Windows 10 Enterprise, Windows 10 Professional, and Windows 10 Education.
{{< /note >}}

### Install Minikube using Chocolatey

The easiest way to install Minikube on Windows is using [Chocolatey](https://chocolatey.org/) (run as an administrator):

```shell
Expand All @@ -131,13 +163,17 @@ choco install minikube kubernetes-cli

After Minikube has finished installing, close the current CLI session and restart. Minikube should have been added to your path automatically.

#### Windows manual installation
### Install Minikube using an installer executable

To install Minikube manually on Windows using [Windows Installer](https://docs.microsoft.com/en-us/windows/desktop/msi/windows-installer-portal), download [`minikube-installer.exe`](https://github.com/kubernetes/minikube/releases/latest/minikube-installer.exe) and execute the installer.

### Install Minikube via direct download

To install Minikube manually on Windows, download [`minikube-windows-amd64`](https://github.com/kubernetes/minikube/releases/latest), rename it to `minikube.exe`, and add it to your path.

#### Windows Installer
{{% /tab %}}
{{< /tabs >}}

To install Minikube manually on windows using [Windows Installer](https://docs.microsoft.com/en-us/windows/desktop/msi/windows-installer-portal), download [`minikube-installer.exe`](https://github.com/kubernetes/minikube/releases/latest) and execute the installer.

{{% /capture %}}

Expand Down

0 comments on commit 5c3e795

Please sign in to comment.