Skip to content

Commit f0feff0

Browse files
tstrombergtstromberg
authored
Merge pull request #7252 from medyagh/kic_docs
add site docs for docker/podman driver
2 parents ef7d5fb + 26bdbfe commit f0feff0

20 files changed

+169
-67
lines changed

‎site/content/en/_index.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,14 @@ <h3>Highlights</h3>
8383
{{% /blocks/feature %}}
8484

8585
{{% blocks/feature icon="fa-thumbs-up" title="Cross-platform" %}}
86-
- Bare-metal
87-
- HyperKit
88-
- Hyper-V
8986
- KVM
87+
- Docker
88+
- HyperKit
89+
- Bare-metal
9090
- VirtualBox
91+
- Hyper-V
9192
- VMware
93+
- Podman
9294
{{% /blocks/feature %}}
9395
{{< /blocks/section >}}
9496

‎site/content/en/docs/Contributing/triage.md

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ If the issue is specific to an operating system, hypervisor, container, addon, o
6262
- `co/kvm2`
6363
- `co/none-driver`
6464
- `co/docker-driver`
65+
- `co/podman-driver`
6566
- `co/virtualbox`
6667

6768
**co/[kubernetes component]** - When the issue appears specific to a k8s component

‎site/content/en/docs/Reference/Drivers/docker.md

+6-16
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,18 @@ linkTitle: "docker"
44
weight: 3
55
date: 2020-02-05
66
description: >
7-
Docker driver (EXPERIMENTAL)
7+
Docker driver
88
---
99

1010
## Overview
1111

12-
The Docker driver is an experimental VM-free driver that ships with minikube v1.7.
12+
The Docker driver is the newest minikube driver. which runs kubernetes in container VM-free ! with full feature parity with minikube in VM.
1313

14-
This driver was inspired by the [kind project](https://kind.sigs.k8s.io/), and uses a modified version of its base image.
14+
{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}}
1515

16-
## Special features
17-
18-
No hypervisor required when run on Linux.
19-
20-
## Limitations
2116

22-
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)
23-
24-
## Issues
25-
26-
* [Full list of open 'kic-driver' issues](https://github.com/kubernetes/minikube/labels/co%2Fkic-driver)
17+
## Special features
18+
- Cross platform (linux, macos, windows)
19+
- No hypervisor required when run on Linux.
2720

28-
## Troubleshooting
2921

30-
* Run `minikube start --alsologtostderr -v=1` to debug crashes
31-
* If your docker is too slow on mac os try [Improving docker performance](https://docs.docker.com/docker-for-mac/osxfs-caching/)

‎site/content/en/docs/Reference/Drivers/hyperv.md

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ date: 2018-08-05
77
description: >
88
Microsoft Hyper-V driver
99
---
10-
1110
## Overview
1211

1312
Hyper-V is a native hypervisor built in to modern versions of Microsoft Windows.

‎site/content/en/docs/Reference/Drivers/includes/check_baremetal_linux.inc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
To use baremetal driver (none driver). verify that your operating system is Linux and also have 'systemd' installed.
2+
3+
```shell
4+
pidof systemd && echo "yes" || echo "no"
5+
```
6+
If the above command outputs "no":
7+
Your system is not suitable for none driver.

‎site/content/en/docs/Reference/Drivers/includes/check_virtualization_linux.inc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
To use VM drivers, verify that your system has virtualization support enabled:
2+
3+
```shell
4+
egrep -q 'vmx|svm' /proc/cpuinfo && echo yes || echo no
5+
```
6+
7+
If the above command outputs "no":
8+
9+
- If you are running within a VM, your hypervisor does not allow nested virtualization. You will need to use the *None (bare-metal)* driver
10+
- If you are running on a physical machine, ensure that your BIOS has hardware virtualization enabled
11+

‎site/content/en/docs/Reference/Drivers/includes/check_virtualization_windows.inc

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
To check if virtualization is supported, run the following command on your Windows terminal or command prompt.
2+
3+
```shell
4+
systeminfo
5+
```
6+
If you see the following output, virtualization is supported:
7+
8+
```shell
9+
Hyper-V Requirements: VM Monitor Mode Extensions: Yes
10+
Virtualization Enabled In Firmware: Yes
11+
Second Level Address Translation: Yes
12+
Data Execution Prevention Available: Yes
13+
```
14+
15+
If you see the following output, your system already has a Hypervisor installed and you can skip the next step.
16+
17+
```shell
18+
Hyper-V Requirements: A hypervisor has been detected.
19+
```

‎site/content/en/docs/Reference/Drivers/includes/docker_usage.inc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Install Docker
2+
3+
- [Docker Desktop](https://hub.docker.com/search?q=&type=edition&offering=community&sort=updated_at&order=desc)
4+
5+
## Usage
6+
7+
Start a cluster using the docker driver:
8+
9+
```shell
10+
minikube start --driver=docker
11+
```
12+
To make docker the default driver:
13+
14+
```shell
15+
minikube config set driver docker
16+
```

‎site/content/en/docs/Reference/Drivers/includes/podman_usage.inc

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## experimental
2+
3+
This is an experimental driver. please use it only for experimental reasons.
4+
for a better kubernetes in container experience, use docker [driver](https://minikube.sigs.k8s.io/docs/reference/drivers/docker).
5+
6+
## Install Podman
7+
8+
- [Podman](https://podman.io/getting-started/installation.html)
9+
10+
## Usage
11+
12+
Start a cluster using the docker driver:
13+
14+
```shell
15+
minikube start --driver=podman
16+
```
17+
To make docker the default driver:
18+
19+
```shell
20+
minikube config set driver podman
21+
```

‎site/content/en/docs/Reference/Drivers/kvm2.md

+5
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,17 @@ description: >
88
Linux KVM (Kernel-based Virtual Machine) driver
99
---
1010

11+
1112
## Overview
1213

1314
[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/)
1415

1516
{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}}
1617

18+
## Check virtualization support
19+
20+
{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_linux.inc" %}}
21+
1722
## Special features
1823

1924
The `minikube start` command supports 3 additional kvm specific flags:

‎site/content/en/docs/Reference/Drivers/podman.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "podman"
3+
linkTitle: "podman"
4+
weight: 3
5+
date: 2020-03-26
6+
description: >
7+
Podman driver
8+
---
9+
10+
## Overview
11+
12+
The podman driver is another kubernetes in container driver for minikube. simmilar to [docker](https://minikube.sigs.k8s.io/docs/reference/drivers/docker/) driver.
13+
podman driver is currently experimental.
14+
and only supported on Linux and MacOs (with a remote podman server)
15+
16+
17+
## Try it with CRI-O container runtime.
18+
```shell
19+
minikube start --driver=podman --container-runtime=cri-o
20+
```
21+
22+
23+
{{% readfile file="/docs/Reference/Drivers/includes/podman_usage.inc" %}}
24+
25+
26+

‎site/content/en/docs/Reference/disk_cache.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: "Disk cache"
44
weight: 6
55
date: 2019-08-01
66
description: >
7-
Cache Rules Everything Around Minikube
7+
Cache Rules Everything Around minikube
88
---
99

1010
minikube has built-in support for caching downloaded resources into `$MINIKUBE_HOME/cache`. Here are the important file locations:

‎site/content/en/docs/Reference/persistent_volumes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >
77
About persistent volumes (hostPath)
88
---
99

10-
minikube supports [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) of type `hostPath` out of the box. These PersistentVolumes are mapped to a directory inside the running Minikube instance (usually a VM, unless you use `--driver=none`, `--driver=docker`, or `--driver=podman`). For more information on how this works, read the Dynamic Provisioning section below.
10+
minikube supports [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) of type `hostPath` out of the box. These PersistentVolumes are mapped to a directory inside the running minikube instance (usually a VM, unless you use `--driver=none`, `--driver=docker`, or `--driver=podman`). For more information on how this works, read the Dynamic Provisioning section below.
1111

1212
## A note on mounts, persistence, and minikube hosts
1313

‎site/content/en/docs/Start/includes/post_install.inc

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
### Getting to know Kubernetes
1+
## Getting to know Kubernetes
22

33
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:
44

55
```shell
66
kubectl get po -A
77
```
88

9-
### Increasing memory allocation
9+
## Increasing memory allocation
1010

11-
minikube only allocates 2GB of RAM by default, which is only enough for trivial deployments. For larger
11+
minikube auto-selects the memory size based on your system up to 6000mb. For larger
1212
deployments, increase the memory allocation using the `--memory` flag, or make the setting persistent using:
1313

1414
```shell
15-
minikube config set memory 4096
15+
minikube config set memory 8096
1616
```
1717

18-
### Where to go next?
18+
## Where to go next?
1919

2020
Visit the [examples](/docs/examples) page to get an idea of what you can do with minikube.
2121

‎site/content/en/docs/Start/linux.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -39,32 +39,39 @@ curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-{{< la
3939
{{% /tab %}}
4040
{{% /tabs %}}
4141

42-
## Hypervisor Setup
43-
44-
Verify that your system has virtualization support enabled:
45-
46-
```shell
47-
egrep -q 'vmx|svm' /proc/cpuinfo && echo yes || echo no
48-
```
49-
50-
If the above command outputs "no":
51-
52-
- If you are running within a VM, your hypervisor does not allow nested virtualization. You will need to use the *None (bare-metal)* driver
53-
- If you are running on a physical machine, ensure that your BIOS has hardware virtualization enabled
42+
## Driver Setup
5443

5544
{{% tabs %}}
45+
{{% tab "Docker" %}}
46+
## Check container support
47+
{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}}
48+
{{% /tab %}}
5649

5750
{{% tab "KVM" %}}
51+
## Check virtualization support
52+
{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_linux.inc" %}}
53+
5854
{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}}
5955
{{% /tab %}}
6056
{{% tab "VirtualBox" %}}
57+
## Check virtualization support
58+
{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_linux.inc" %}}
59+
6160
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}
6261
{{% /tab %}}
6362
{{% tab "None (bare-metal)" %}}
63+
## Check baremetal support
64+
{{% readfile file="/docs/Reference/Drivers/includes/check_baremetal_linux.inc" %}}
65+
6466
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.
6567

6668
{{% readfile file="/docs/Reference/Drivers/includes/none_usage.inc" %}}
6769
{{% /tab %}}
70+
{{% tab "Podman (experimental)" %}}
71+
{{% readfile file="/docs/Reference/Drivers/includes/podman_usage.inc" %}}
72+
{{% /tab %}}
73+
74+
6875
{{% /tabs %}}
6976

7077
{{% readfile file="/docs/Start/includes/post_install.inc" %}}

‎site/content/en/docs/Start/macos.md

+6
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ brew upgrade minikube
5050
## Hypervisor Setup
5151

5252
{{% tabs %}}
53+
{{% tab "Docker" %}}
54+
{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}}
55+
{{% /tab %}}
5356
{{% tab "Hyperkit" %}}
5457
{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.inc" %}}
5558
{{% /tab %}}
@@ -62,6 +65,9 @@ brew upgrade minikube
6265
{{% tab "VMware" %}}
6366
{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.inc" %}}
6467
{{% /tab %}}
68+
{{% tab "Podman (experimental)" %}}
69+
{{% readfile file="/docs/Reference/Drivers/includes/podman_usage.inc" %}}
70+
{{% /tab %}}
6571

6672
{{% /tabs %}}
6773

‎site/content/en/docs/Start/windows.md

+10-22
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ weight: 3
77
### Prerequisites
88

99
* Windows 8 or above
10-
* A hypervisor, such as Hyper-V or VirtualBox
11-
* Hardware virtualization support must be enabled in BIOS
1210
* 4GB of RAM
1311

1412
### Installation
@@ -30,33 +28,23 @@ After it has installed, close the current CLI session and reopen it. minikube sh
3028
{{% /tab %}}
3129
{{% /tabs %}}
3230

33-
## Hypervisor Setup
3431

35-
To check if virtualization is supported, run the following command on your Windows terminal or command prompt.
36-
37-
```shell
38-
systeminfo
39-
```
40-
If you see the following output, virtualization is supported:
41-
42-
```shell
43-
Hyper-V Requirements: VM Monitor Mode Extensions: Yes
44-
Virtualization Enabled In Firmware: Yes
45-
Second Level Address Translation: Yes
46-
Data Execution Prevention Available: Yes
47-
```
48-
49-
If you see the following output, your system already has a Hypervisor installed and you can skip the next step.
50-
51-
```shell
52-
Hyper-V Requirements: A hypervisor has been detected.
53-
```
5432

5533
{{% tabs %}}
34+
{{% tab "Docker" %}}
35+
{{% readfile file="/docs/Reference/Drivers/includes/docker_usage.inc" %}}
36+
{{% /tab %}}
37+
5638
{{% tab "Hyper-V" %}}
39+
## Check Hypervisor
40+
{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_windows.inc" %}}
41+
5742
{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.inc" %}}
5843
{{% /tab %}}
5944
{{% tab "VirtualBox" %}}
45+
## Check Hypervisor
46+
{{% readfile file="/docs/Reference/Drivers/includes/check_virtualization_windows.inc" %}}
47+
6048
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}
6149
{{% /tab %}}
6250
{{% /tabs %}}

‎site/content/en/docs/Tutorials/continuous_integration.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ description: >
99

1010
## Overview
1111

12-
Most continuous integration environments are already running inside a VM, and may not support nested virtualization. The `none` driver was designed for this use case.
12+
Most continuous integration environments are already running inside a VM, and may not support nested virtualization. The `none` driver was designed for this use case. or you could alternatively use the [Docker](https://minikube.sigs.k8s.io/docs/reference/drivers/docker).
1313

1414
## Prerequisites
1515

1616
- VM running a systemd based Linux distribution
1717

18-
## Tutorial
18+
## using none driver
1919

2020
Here is an example, that runs minikube from a non-root user, and ensures that the latest stable kubectl is installed:
2121

@@ -39,3 +39,7 @@ touch $KUBECONFIG
3939

4040
sudo -E minikube start --driver=none
4141
```
42+
43+
## Alternative ways
44+
45+
you could alternatively use minikube's container drivers such as [Docker](https://minikube.sigs.k8s.io/docs/reference/drivers/docker) or [Podman](https://minikube.sigs.k8s.io/docs/reference/drivers/podman).

‎site/content/en/docs/Tutorials/nvidia_gpu.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ to expose GPUs with `--driver=kvm2`. Please don't mix these instructions.
9898

9999
## Why does minikube not support NVIDIA GPUs on macOS?
100100

101-
VM drivers supported by minikube for macOS doesn't support GPU passthrough:
101+
drivers supported by minikube for macOS doesn't support GPU passthrough:
102102

103103
- [mist64/xhyve#108](https://github.com/mist64/xhyve/issues/108)
104104
- [moby/hyperkit#159](https://github.com/moby/hyperkit/issues/159)

0 commit comments

Comments
 (0)