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