Fill in getting started instructions for the various hypervisors

pull/4935/head
Thomas Stromberg 2019-08-01 17:24:23 -07:00
parent ae84466473
commit a24bbccefa
8 changed files with 167 additions and 35 deletions

View File

@ -64,6 +64,9 @@ weight = 1
# Everything below this are Site Params
[params]
# The latest release of minikube
latest_release = "1.2.0"
copyright = "The Linux Foundation"
privacy_policy = ""

View File

@ -1,7 +0,0 @@
Use any regular Kubernetes command to interact with your minikube cluster. For example, you can see the pod states by running:
```shell
kubectl get po -A
```
Visit the [examples](/docs/examples) page to get a fuller idea of what you can do with minikube.

View File

@ -0,0 +1,19 @@
### Getting to know Kubernetes
Once started, you can use any regular Kubernetes command to interact with your minikube cluster. For example, you can see the pod states by running:
```shell
kubectl get po -A
```
### Increasing memory allocation
minikube only allocates a 2GB of RAM to Kubernetes, which is only enough for basic deployments. If you run into stability issues, increase this value if your system has the resources available. You will need to recreate the VM using `minikube delete` for this to take effect.
```shell
minikube config set memory 4096
```
### Where to go next?
Visit the [examples](/docs/examples) page to get an idea of what you can do with minikube.

View File

@ -1,5 +1,7 @@
Just download the latest version from https://www.virtualbox.org/. No flags necessary:
Dwnload and install the latest version of VirtualBox from https://www.virtualbox.org/
Once installed, you can start minikube without any special flags:
```shell
minikube start
```
```

View File

@ -9,7 +9,7 @@ description: >
## Installation
{{% tabs %}}
{{% tab "Manual" %}}
{{% tab "Direct" %}}
Download and install minikube to /usr/local/bin:
@ -19,9 +19,25 @@ Download and install minikube to /usr/local/bin:
```
{{% /tab %}}
{{% tab "Debian/Ubuntu (apt)" %}}
Download and install minikube:
```shell
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_{{< latest >}}.deb \
&& dpkg -i minikube_{{< latest >}}.deb
```
{{% /tab %}}
{{% tab "Fedora/Red Hat (rpm)" %}}
Download and install minikube:
```shell
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_{{< latest >}}.rpm \
&& rpm -ivh minikube_{{< latest >}}.rpm
```
{{% /tab %}}
{{% /tabs %}}
@ -69,20 +85,27 @@ virt-host-validate
If you see any errors, stop now and consult your distributions documentation on configuring libvirt.
### Trying the kvm2 driver
### Using the kvm2 driver
```shell
minikube start --vm-driver=kvm2
```
### Making the kvm2 driver the default
To make the kvm2 driver to be the default for future minikube invocations, run:
```shell
minikube config set vm-driver kvm2
```
{{% /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. It does require sudo access:
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
@ -92,6 +115,4 @@ Please see the [docs/reference/drivers/none](none driver) documentation for more
{{% /tab %}}
{{% /tabs %}}
## Where should I go next?
{{% readfile file="/docs/Getting started/_next_steps.md" %}}
{{% readfile file="/docs/Getting started/_post_install.md" %}}

View File

@ -16,14 +16,14 @@ description: >
{{% tabs %}}
{{% tab "Brew" %}}
Download and install minikube to /usr/local/bin:
If you have the [Brew Package Manager](https://brew.sh/) installed, this will download and install minikube to /usr/local/bin:
```shell
brew install minikube
```
{{% /tab %}}
{{% tab "Manual" %}}
{{% tab "Direct" %}}
Download and install minikube to /usr/local/bin:
@ -43,19 +43,72 @@ curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin
{{% /tab %}}
{{% tab "Hyperkit" %}}
The easiest way to install hyperkit is using the [Brew Package Manager](https://brew.sh/):
```shell
brew install hyperkit
```
To use minikube and hyperkit reliably, please download and install our improved fork of the driver:
```shell
curl -LO https://storage.googleapis.com/minikube/releases/latest/docker-machine-driver-hyperkit \
&& sudo install docker-machine-driver-hyperkit /usr/local/bin/
sudo chown root:wheel /usr/local/bin/docker-machine-driver-hyperkit
sudo chmod u+s /usr/local/bin/docker-machine-driver-hyperkit
```
This driver requires root privileges to create and destroy network interfaces:
```shell
sudo chown root:wheel /usr/local/bin
docker-machine-driver-hyperkit \
&& sudo chmod u+s /usr/local/bin/docker-machine-driver-hyperkit
```
### Using the hyperkit driver
```shell
minikube start --vm-driver=hyperkit
```
To make the hyperkit driver to be the default for future minikube invocations, run:
```shell
minikube config set vm-driver hyperkit
```
{{% /tab %}}
{{% tab "Parallels" %}}
Start minikube with Parallels support using:
```shell
minikube start --vm-driver=parallels
```
To make the parallels driver to be the default for future minikube invocations, run:
```shell
minikube config set vm-driver parallels
```
{{% /tab %}}
{{% tab "VMWare Fusion" %}}
{{% tab "VMware Fusion" %}}
Start minikube with VMware support using:
```shell
minikube start --vm-driver=vmware
```
To make the vmware driver to be the default for future minikube invocations, run:
```shell
minikube config set vm-driver vmware
```
{{% /tab %}}
{{% /tabs %}}
{{% readfile file="/docs/Getting started/_post_install.md" %}}

View File

@ -8,37 +8,77 @@ description: >
### Prerequisites
* A hypervisor, such as VirtualBox (recommended) or HyperV
* VT-x/AMD-v virtualization must be enabled in BIOS
* Windows 8 or above
* A hypervisor, such as Hyper-V or VirtualBox
* Hardware virtualization support must be enabled in BIOS
* 4GB of RAM
### Installation
{{% tabs %}}
{{% tab "Direct" %}}
Download and run the [installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe)
{{% /tab %}}
## Try it out!
{{% tab "Chocolatey" %}}
Start your first Kubernetes cluster:
If you have the [Chocolatey Package Manager](https://chocolatey.org/) installed, you can install minikube if run as an Administrator:
```shell
minikube start
choco install minikube
```
If `kubectl` is installed, this will show a status of all of the pods:
After it has installed, close the current CLI session and reopen it. minikube should have been added to your path automatically.
{{% /tab %}}
{{% /tabs %}}
## Hypervisor Setup
To check if virtualization is supported, run the following command on your Windows terminal or command prompt.
```shell
kubectl get po -A
systeminfo
```
## Further Setup
Once you have picked a hypervisor, you may set it as the default for future invocations:
If you see the following output, virtualization is supported:
```shell
minikube config set vm-driver <driver>
Hyper-V Requirements: VM Monitor Mode Extensions: Yes
Virtualization Enabled In Firmware: Yes
Second Level Address Translation: Yes
Data Execution Prevention Available: Yes
```
minikube only allocates a 2GB of RAM to Kubernetes, which is only enough for basic deployments. If you run into stability issues, increase this value if your system has the resources available:
If you see the following output, your system already has a Hypervisor installed and you can skip the next step.
```
Hyper-V Requirements: A hypervisor has been detected.
Features required for Hyper-V will not be displayed.
```
{{% tabs %}}
{{% tab "VirtualBox" %}}
{{% readfile file="/docs/Getting started/_virtualbox.md" %}}
{{% /tab %}}
{{% tab "Hyper-V" %}}
If Hyper-V is active, you can start minikube with Hyper-V support using:
```shell
minikube config set memory 4096
minikube start --vm-driver=hyperv
```
NOTE: If this doesn't work, you may need to create an external switch.
To make the hyperv driver to be the default for future minikube invocations, run:
```shell
minikube config set vm-driver hyperv
```
{{% /tab %}}
{{% /tabs %}}
{{% readfile file="/docs/Getting started/_post_install.md" %}}

View File

@ -0,0 +1 @@
{{ $.Site.Params.latest_release }}