Skip to content

Commit fca1d58

Browse files
authored
Update minikube documentation (#19756)
* Update vm-driver param and driver links * Fix mistakes * Fix spaces * Revert "Fix spaces" This reverts commit c08906d * Revert "Fix mistakes" This reverts commit c6c14b6 * Revert "Update vm-driver param and driver links" This reverts commit 164729d * Update vm-driver param and driver links
1 parent 73ddd2f commit fca1d58

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

content/en/docs/setup/learning-environment/minikube.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -187,24 +187,26 @@ example, to run version {{< param "fullversion" >}}, you would run the following
187187
minikube start --kubernetes-version {{< param "fullversion" >}}
188188
```
189189
#### Specifying the VM driver
190-
You can change the VM driver by adding the `--vm-driver=<enter_driver_name>` flag to `minikube start`.
190+
You can change the VM driver by adding the `--driver=<enter_driver_name>` flag to `minikube start`.
191191
For example the command would be.
192192
```shell
193-
minikube start --vm-driver=<driver_name>
193+
minikube start --driver=<driver_name>
194194
```
195195
Minikube supports the following drivers:
196196
{{< note >}}
197-
See [DRIVERS](https://git.k8s.io/minikube/docs/drivers.md) for details on supported drivers and how to install
197+
See [DRIVERS](https://minikube.sigs.k8s.io/docs/reference/drivers/) for details on supported drivers and how to install
198198
plugins.
199199
{{< /note >}}
200200

201201
* virtualbox
202202
* vmwarefusion
203-
* kvm2 ([driver installation](https://git.k8s.io/minikube/docs/drivers.md#kvm2-driver))
204-
* hyperkit ([driver installation](https://git.k8s.io/minikube/docs/drivers.md#hyperkit-driver))
205-
* hyperv ([driver installation](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperv-driver))
203+
* docker (EXPERIMENTAL)
204+
* kvm2 ([driver installation](https://minikube.sigs.k8s.io/docs/reference/drivers/kvm2/))
205+
* hyperkit ([driver installation](https://minikube.sigs.k8s.io/docs/reference/drivers/hyperkit/))
206+
* hyperv ([driver installation](https://minikube.sigs.k8s.io/docs/reference/drivers/hyperv/))
206207
Note that the IP below is dynamic and can change. It can be retrieved with `minikube ip`.
207-
* vmware ([driver installation](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver)) (VMware unified driver)
208+
* vmware ([driver installation](https://minikube.sigs.k8s.io/docs/reference/drivers/vmware/)) (VMware unified driver)
209+
* parallels ([driver installation](https://minikube.sigs.k8s.io/docs/reference/drivers/parallels/))
208210
* none (Runs the Kubernetes components on the host and not in a virtual machine. You need to be running Linux and to have {{< glossary_tooltip term_id="docker" >}} installed.)
209211

210212
{{< caution >}}

content/en/docs/tasks/tools/install-minikube.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ grep -E --color 'vmx|svm' /proc/cpuinfo
2626
{{% tab name="macOS" %}}
2727
To check if virtualization is supported on macOS, run the following command on your terminal.
2828
```
29-
sysctl -a | grep -E --color 'machdep.cpu.features|VMX'
29+
sysctl -a | grep -E --color 'machdep.cpu.features|VMX'
3030
```
3131
If you see `VMX` in the output (should be colored), the VT-x feature is enabled in your machine.
3232
{{% /tab %}}
@@ -74,7 +74,7 @@ If you do not already have a hypervisor installed, install one of these now:
7474

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

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

8080
If you're using the `none` driver in Debian or a derivative, use the `.deb` packages for
@@ -83,7 +83,7 @@ You can download `.deb` packages from [Docker](https://www.docker.com/products/d
8383

8484
{{< caution >}}
8585
The `none` VM driver can result in security and data loss issues.
86-
Before using `--vm-driver=none`, consult [this documentation](https://minikube.sigs.k8s.io/docs/reference/drivers/none/) for more information.
86+
Before using `--driver=none`, consult [this documentation](https://minikube.sigs.k8s.io/docs/reference/drivers/none/) for more information.
8787
{{< /caution >}}
8888

8989
Minikube also supports a `vm-driver=podman` similar to the Docker driver. Podman run as superuser privilege (root user) is the best way to ensure that your containers have full access to any feature available on your system.
@@ -214,12 +214,12 @@ To confirm successful installation of both a hypervisor and Minikube, you can ru
214214

215215
{{< note >}}
216216

217-
For setting the `--vm-driver` with `minikube start`, enter the name of the hypervisor you installed in lowercase letters where `<driver_name>` is mentioned below. A full list of `--vm-driver` values is available in [specifying the VM driver documentation](https://kubernetes.io/docs/setup/learning-environment/minikube/#specifying-the-vm-driver).
217+
For setting the `--driver` with `minikube start`, enter the name of the hypervisor you installed in lowercase letters where `<driver_name>` is mentioned below. A full list of `--driver` values is available in [specifying the VM driver documentation](https://kubernetes.io/docs/setup/learning-environment/minikube/#specifying-the-vm-driver).
218218

219219
{{< /note >}}
220220

221221
```shell
222-
minikube start --vm-driver=<driver_name>
222+
minikube start --driver=<driver_name>
223223
```
224224

225225
Once `minikube start` finishes, run the command below to check the status of the cluster:

0 commit comments

Comments
 (0)