Skip to content

Commit e50b640

Browse files
Merge pull request kubernetes#23485 from yash2006kr/docs-vmnet-helper-homebrew
docs: recommend Homebrew vmnet-helper install on macOS 26
2 parents 14bf45e + 28b3984 commit e50b640

3 files changed

Lines changed: 41 additions & 58 deletions

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
### Install vmnet-helper
2+
3+
On macOS 26 or later, install vmnet-helper using [Homebrew](https://brew.sh/):
4+
5+
```shell
6+
brew tap nirs/vmnet-helper
7+
brew trust nirs/vmnet-helper
8+
brew install vmnet-helper
9+
```
10+
11+
On macOS 15 or earlier, install the latest version using the install script:
12+
13+
```shell
14+
curl -fsSL https://github.com/minikube-machine/vmnet-helper/releases/latest/download/install.sh | bash
15+
```
16+
17+
The command downloads the latest release from GitHub and installs it to
18+
`/opt/vmnet-helper`, and configures a sudoers rule to allow running
19+
vmnet-helper without a password.
20+
21+
### Grant permission to run vmnet-helper manually on macOS 15 or earlier
22+
23+
On macOS 15 or earlier, vmnet-helper must run as root to create a vmnet
24+
interface. To let users in the staff group run it without a password, install the
25+
default sudoers rule. The install script offers to add this automatically; if you
26+
declined, run the command below manually:
27+
28+
```shell
29+
sudo install -m 0640 /opt/vmnet-helper/share/doc/vmnet-helper/sudoers.d/vmnet-helper /etc/sudoers.d/
30+
```
31+
32+
You can change the sudoers configuration to allow access to specific
33+
users or other groups.
34+
35+
**IMPORTANT**: On macOS 15 or earlier, the vmnet-helper executable and the
36+
directory where it is installed must be owned by root and may not be modifiable
37+
by unprivileged users.

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

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -39,37 +39,7 @@ To use the krunkit driver you must install
3939
[vmnet-helper](https://github.com/nirs/vmnet-helper), see installation
4040
instructions below.
4141

42-
### Install vment-helper
43-
44-
```shell
45-
curl -fsSL https://github.com/minikube-machine/vmnet-helper/releases/latest/download/install.sh | bash
46-
```
47-
48-
The command downloads the latest release from github and installs it to
49-
`/opt/vmnet-helper`.
50-
51-
{{% alert title="Note" color="primary" %}}
52-
The vmnet-helper executable and the directory where it is installed
53-
must be owned by root and may not be modifiable by unprivileged users.
54-
{{% /alert %}}
55-
56-
### Grant permission to run vmnet-helper manually (if said no to script above)
57-
58-
59-
The vment-helper process must run as root to create a vmnet interface.
60-
To allow users in the `staff` group to run the vmnet helper without a
61-
password, you can install the default sudoers rule:
62-
63-
The installation script will ask your permission to add to the sudoers but if you say no and prefer to do manually here is the command:
64-
65-
```shell
66-
sudo install -m 0640 /opt/vmnet-helper/share/doc/vmnet-helper/sudoers.d/vmnet-helper /etc/sudoers.d/
67-
```
68-
69-
You can change the sudoers configuration to allow access to specific
70-
users or other groups.
71-
72-
42+
{{% readfile file="/docs/drivers/includes/vmnet_helper.inc" %}}
7343

7444
### Usage
7545

@@ -115,7 +85,7 @@ Run `minikube start --driver krunkit --alsologtostderr -v=7` to debug crashes
11585

11686
### Troubleshooting vmnet-helper
11787

118-
Check for errors in vment-helper log:
88+
Check for errors in vmnet-helper log:
11989

12090
```shell
12191
$MINIKUBE_HOME/.minikube/machines/MACHINE-NAME/vmnet-helper.log
@@ -129,5 +99,5 @@ ps au | grep vmnet-helper | grep -v grep
12999

130100
If the helper is not running restart the minikube cluster.
131101

132-
For help with vment-helper please use the
102+
For help with vmnet-helper please use the
133103
[discussions](https://github.com/nirs/vmnet-helper/discussions).

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

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,7 @@ installation instructions below.
3232

3333
- Requires [vmnet-helper](https://github.com/nirs/vmnet-helper).
3434

35-
### Install vmnet-helper
36-
37-
```shell
38-
curl -fsSL https://github.com/minikube-machine/vmnet-helper/releases/latest/download/install.sh | bash
39-
```
40-
41-
The command downloads the latest release from github and installs it to
42-
`/opt/vmnet-helper`.
43-
44-
### Grant permission to run vmnet-helper manually (if said no to script above)
45-
46-
vmnet-helper must run as root to create a vmnet interface. To let users in the staff group run it without a password, install the default sudoers rule. The install script offers to add this automatically; if you declined, run the command below manually:
47-
48-
```shell
49-
sudo install -m 0640 /opt/vmnet-helper/share/doc/vmnet-helper/sudoers.d/vmnet-helper /etc/sudoers.d/
50-
```
51-
52-
You can change the sudoers configuration to allow access to specific
53-
users or other groups.
54-
55-
56-
**IMPORTANT**: The vmnet-helper executable and the directory where it is
57-
installed must be owned by root and may not be modifiable by
58-
unprivileged users.
59-
35+
{{% readfile file="/docs/drivers/includes/vmnet_helper.inc" %}}
6036

6137
### Usage
6238

0 commit comments

Comments
 (0)