Skip to content

Commit 7cda3a5

Browse files
committed
site: Add krunkit driver documentation
1 parent 9dbe26a commit 7cda3a5

File tree

2 files changed

+92
-0
lines changed

2 files changed

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

0 commit comments

Comments
 (0)