Skip to content

Commit cbe0012

Browse files
committed
site: Add krunkit driver documentation
1 parent 99dd14d commit cbe0012

File tree

2 files changed

+93
-0
lines changed

2 files changed

+93
-0
lines changed

site/content/en/docs/drivers/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ To do so, we use the [Docker Machine](https://github.com/docker/machine) library
3333
* [QEMU]({{<ref "qemu.md">}}) - VM
3434
* [Podman]({{<ref "podman.md">}}) - VM + Container (experimental)
3535
* [VFkit]({{<ref "vfkit.md">}}) - VM (preferred)
36+
* [Krunkit]({{<ref "krunkit.md">}}) - VM (experimental)
3637
* [SSH]({{<ref "ssh.md">}}) - remote ssh
3738

3839
## Windows
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: "krunkit"
3+
weight: 2
4+
aliases:
5+
- /docs/reference/drivers/krunkit
6+
---
7+
8+
## Overview
9+
10+
[krunkit](https://github.com/containers/krunkit) is an open-source program for
11+
macOS virtualization, optimized for GPU accelerated virtual machines and AI
12+
workloads.
13+
14+
## Requirements
15+
16+
- Available only on Apple silicon
17+
- Requires macOS 10.15 or later
18+
- Requires minikube version 1.37.0 or later.
19+
- Requires [vmnet-helper](https://github.com/nirs/vmnet-helper).
20+
21+
## Networking
22+
23+
The krunkit driver requires [vmnet-helper](https://github.com/nirs/vmnet-helper), see
24+
installation instructions bellow.
25+
26+
### Install vment-helper
27+
28+
```shell
29+
tag="$(curl -fsSL https://api.github.com/repos/nirs/vmnet-helper/releases/latest | jq -r .tag_name)"
30+
machine="$(uname -m)"
31+
archive="vmnet-helper-$tag-$machine.tar.gz"
32+
curl -LOf "https://github.com/nirs/vmnet-helper/releases/download/$tag/$archive"
33+
sudo tar xvf "$archive" -C / opt/vmnet-helper
34+
rm "$archive"
35+
```
36+
37+
The command downloads the latest release from github and installs it to
38+
`/opt/vmnet-helper`.
39+
40+
**IMPORTANT**: The vmnet-helper executable and the directory where it is
41+
installed must be owned by root and may not be modifiable by
42+
unprivileged users.
43+
44+
### Grant permission to run vmnet-helper
45+
46+
The vment-helper process must run as root to create a vmnet interface.
47+
To allow users in the `staff` group to run the vmnet helper without a
48+
password, you can install the default sudoers rule:
49+
50+
```shell
51+
sudo install -m 0640 /opt/vmnet-helper/share/doc/vmnet-helper/sudoers.d/vmnet-helper /etc/sudoers.d/
52+
```
53+
54+
You can change the sudoers configuration to allow access to specific
55+
users or other groups.
56+
57+
### Usage
58+
59+
```shell
60+
minikube start --driver krunkit
61+
```
62+
63+
## Issues
64+
65+
### Other
66+
67+
* [Full list of open 'krunkit' driver issues](https://github.com/kubernetes/minikube/labels/co%2Fkrunkit)
68+
69+
## Troubleshooting
70+
71+
### Run with logs
72+
73+
Run `minikube start --driver vfkit --alsologtostderr -v=7` to debug crashes
74+
75+
### Troubleshooting vmnet-helper
76+
77+
Check for errors in vment-helper log:
78+
79+
```shell
80+
$MINIKUBE_HOME/.minikube/machines/MACHINE-NAME/vmnet-helper.log
81+
```
82+
83+
Check that the `vmnet-helper` process is running:
84+
85+
```shell
86+
ps au | grep vmnet-helper | grep -v grep
87+
```
88+
89+
If the helper is not running restart the minikube cluster.
90+
91+
For help with vment-helper please use the
92+
[discussions](https://github.com/nirs/vmnet-helper/discussions).

0 commit comments

Comments
 (0)