vde_vmnet: add more docs

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

README.md

@@ -202,6 +202,8 @@ The current default spec:
   - ["Port forwarding does not work"](#port-forwarding-does-not-work)
   - [stuck on "Waiting for the essential requirement 1 of X: "ssh"](#stuck-on-waiting-for-the-essential-requirement-1-of-x-ssh)
   - ["permission denied" for `limactl cp` command](#permission-denied-for-limactl-cp-command)
+- [Networking](#networking)
+  - ["Cannot access the guest IP 192.168.5.15 from the host"](#cannot-access-the-guest-ip-192168515-from-the-host)
 - ["Hints for debugging other problems?"](#hints-for-debugging-other-problems)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -304,6 +306,15 @@ The `copy` command only works for instances that have been created by lima 0.5.0
 < ~/.lima/_config/user.pub limactl shell INSTANCE sh -c 'tee -a ~/.ssh/authorized_keys'
 ```
 
+### Networking
+#### "Cannot access the guest IP 192.168.5.15 from the host"
+
+The default guest IP 192.168.5.15 is not accessible from the host and other guests.
+
+To add another IP address that is accessible from the host and other virtual machines, enable [`vde_vmnet`](https://github.com/lima-vm/vde_vmnet).
+
+See [`./docs/network.md`](./docs/network.md).
+
 ### "Hints for debugging other problems?"
 - Inspect logs:
   - `limactl --debug start`

docs/internal.md

@@ -85,6 +85,7 @@ The directory contains the following files:
 
 - `user-data`: [Cloud-init user-data](https://cloudinit.readthedocs.io/en/latest/topics/format.html)
 - `meta-data`: [Cloud-init meta-data](https://cloudinit.readthedocs.io/en/latest/topics/instancedata.html)
+- `network-config`: [Cloud-init Networking Config Version 2](https://cloudinit.readthedocs.io/en/latest/topics/network-config-format-v2.html)
 - `lima.env`: the environment variables
 - `lima-guestagent`: Lima guest agent binary
 - `nerdctl-full.tgz`: [`nerdctl-full-<VERSION>-linux-<ARCH>.tar.gz`](https://github.com/containerd/nerdctl/releases)

docs/network.md

@@ -0,0 +1,47 @@
+# Network
+
+## user-mode network (192.168.5.0/24)
+
+By default Lima only enables the user-mode networking aka "slirp".
+
+### Guest IP (192.168.5.15)
+
+The guest IP address is typically set to 192.168.5.15.
+
+This IP address is not accessible from the host by design.
+
+Use `vde_vmnet` to allow accessing the guest IP from the host and other guests.
+
+### Host IP (192.168.5.2)
+
+The loopback addresses of the host is accessible from the guest as 192.168.5.2.
+
+### DNS (192.168.5.3)
+
+The DNS.
+
+## `vde_vmnet` (192.168.105.0/24)
+
+[`vde_vmnet`](https://github.com/lima-vm/vde_vmnet) is required for adding another guest IP that is accessible from
+the host and other guests.
+
+To enable `vde_vmnet` (in addition the user-mode network), add the following lines to the YAML after installing `vde_vmnet`.
+
+```yaml
+network:
+  # The instance can get routable IP addresses from the vmnet framework using
+  # https://github.com/lima-vm/vde_vmnet. Both vde_switch and vde_vmnet
+  # daemons must be running before the instance is started. The interface type
+  # (host, shared, or bridged) is configured in vde_vmnet and not lima.
+  vde:
+    # url points to the vde_switch socket directory
+    - url: "/var/run/vde.ctl"
+      # MAC address of the instance; lima will pick one based on the instance name,
+      # so DHCP assigned ip addresses should remain constant over instance restarts.
+      macAddress: ""
+      # Interface name, defaults to "vde0", "vde1", etc.
+      name: ""
+```
+
+The IP address range is typically `192.168.105.0/24`, but depends on the configuration of `vde_vmnet`.
+See [the documentation of `vde_vmnet`](https://github.com/lima-vm/vde_vmnet) for further information.

pkg/limayaml/default.yaml

@@ -33,7 +33,7 @@ disk: "100GiB"
 
 network:
   # The instance can get routable IP addresses from the vmnet framework using
-  # https://github.com/AkihiroSuda/vde_vmnet. Both vde_switch and vde_vmnet
+  # https://github.com/lima-vm/vde_vmnet. Both vde_switch and vde_vmnet
   # daemons must be running before the instance is started. The interface type
   # (host, shared, or bridged) is configured in vde_vmnet and not lima.
   vde: