Merge pull request #239 from rancher-sandbox/networks

Implement vde_vmnet management

Author: AkihiroSuda

.github/workflows/test.yml

@@ -146,6 +146,9 @@ jobs:
             make PREFIX=/opt/vde
             sudo make PREFIX=/opt/vde install
           )
+          (
+            limactl sudoers | sudo tee /etc/sudoers.d/lima
+          )
       - name: Prepare ssh
         run: |
           if [ -e ~/.ssh/id_rsa ]; then

cmd/limactl/delete.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -42,7 +43,7 @@ func deleteAction(cmd *cobra.Command, args []string) error {
 		}
 		logrus.Infof("Deleted %q (%q)", instName, inst.Dir)
 	}
-	return nil
+	return networks.Reconcile(cmd.Context(), "")
 }
 
 func deleteInstance(inst *store.Instance, force bool) error {

cmd/limactl/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/version"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -38,6 +39,11 @@ func newApp() *cobra.Command {
 		if os.Geteuid() == 0 {
 			return errors.New("must not run as the root")
 		}
+		// Make sure either $HOME or $LIMA_HOME is defined, so we don't need
+		// to check for errors later
+		if _, err := dirnames.LimaDir(); err != nil {
+			return err
+		}
 		return nil
 	}
 	rootCmd.AddCommand(
@@ -48,6 +54,7 @@ func newApp() *cobra.Command {
 		newListCommand(),
 		newDeleteCommand(),
 		newValidateCommand(),
+		newSudoersCommand(),
 		newPruneCommand(),
 		newHostagentCommand(),
 	)

cmd/limactl/start.go

@@ -12,6 +12,7 @@ import (
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/containerd/containerd/identifiers"
 	"github.com/lima-vm/lima/pkg/limayaml"
+	"github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/osutil"
 	"github.com/lima-vm/lima/pkg/start"
 	"github.com/lima-vm/lima/pkg/store"
@@ -119,7 +120,7 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string) (*store.Instance, e
 	if err != nil {
 		return nil, err
 	}
-	if err := limayaml.Validate(*y); err != nil {
+	if err := limayaml.Validate(*y, true); err != nil {
 		if !tty {
 			return nil, err
 		}
@@ -216,6 +217,9 @@ func startAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
+	if len(inst.Errors) > 0 {
+		return fmt.Errorf("errors inspecting instance: %+v", inst.Errors)
+	}
 	switch inst.Status {
 	case store.StatusRunning:
 		logrus.Infof("The instance %q is already running. Run `%s` to open the shell.",
@@ -228,6 +232,10 @@ func startAction(cmd *cobra.Command, args []string) error {
 		logrus.Warnf("expected status %q, got %q", store.StatusStopped, inst.Status)
 	}
 	ctx := cmd.Context()
+	err = networks.Reconcile(ctx, inst.Name)
+	if err != nil {
+		return err
+	}
 	return start.Start(ctx, inst)
 }
 

cmd/limactl/stop.go

@@ -11,6 +11,7 @@ import (
 	"time"
 
 	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
+	"github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/sirupsen/logrus"
@@ -47,10 +48,14 @@ func stopAction(cmd *cobra.Command, args []string) error {
 	}
 	if force {
 		stopInstanceForcibly(inst)
-		return nil
+	} else {
+		err = stopInstanceGracefully(inst)
 	}
-
-	return stopInstanceGracefully(inst)
+	// TODO: should we also reconcile networks if graceful stop returned an error?
+	if err == nil {
+		err = networks.Reconcile(cmd.Context(), "")
+	}
+	return err
 }
 
 func stopInstanceGracefully(inst *store.Instance) error {

cmd/limactl/sudoers.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"runtime"
+
+	"github.com/lima-vm/lima/pkg/networks"
+	"github.com/spf13/cobra"
+)
+
+func newSudoersCommand() *cobra.Command {
+	sudoersCommand := &cobra.Command{
+		Use:   "sudoers [SUDOERSFILE]",
+		Short: "Generate /etc/sudoers.d/lima file.",
+		Args:  cobra.MaximumNArgs(1),
+		RunE:  sudoersAction,
+	}
+	configFile, _ := networks.ConfigFile()
+	sudoersCommand.Flags().Bool("check", false,
+		fmt.Sprintf("check that the sudoers file is up-to-date with %q", configFile))
+	return sudoersCommand
+}
+
+func sudoersAction(cmd *cobra.Command, args []string) error {
+	if runtime.GOOS != "darwin" {
+		return errors.New("sudoers command is only supported on macOS right now")
+	}
+	check, err := cmd.Flags().GetBool("check")
+	if err != nil {
+		return err
+	}
+	if check {
+		return verifySudoAccess(args)
+	}
+	sudoers, err := networks.Sudoers()
+	if err != nil {
+		return err
+	}
+	fmt.Print(sudoers)
+	return nil
+}
+
+func verifySudoAccess(args []string) error {
+	config, err := networks.Config()
+	if err != nil {
+		return err
+	}
+	if err := config.Validate(); err != nil {
+		return err
+	}
+	var file string
+	switch len(args) {
+	case 0:
+		file = config.Paths.Sudoers
+		if file == "" {
+			configFile, _ := networks.ConfigFile()
+			return fmt.Errorf("no sudoers file defined in %q", configFile)
+		}
+	case 1:
+		file = args[0]
+	default:
+		return errors.New("can check only a single sudoers file")
+	}
+	if err := config.VerifySudoAccess(file); err != nil {
+		return err
+	}
+	fmt.Printf("%q is up-to-date (or sudo doesn't require a password)\n", file)
+	return nil
+}

docs/network.md

@@ -28,21 +28,89 @@ 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:
-    # vnl (virtual network locator) points to the vde_switch socket directory,
-    # optionally with vde:// prefix
-    - vnl: "vde:///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: ""
+networks:
+  # vnl (virtual network locator) points to the vde_switch socket directory,
+  # optionally with vde:// prefix
+  # - vnl: "vde:///var/run/vde.ctl"
+  #   # VDE Switch port number (not TCP/UDP port number). Set to 65535 for PTP mode.
+  #   # Default: 0
+  #   switchPort: 0
+  #   # 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 "lima0", "lima1", etc.
+  #   interface: ""
 ```
 
 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.
+
+## Managed VMNet networks (via vde_vmnet)
+
+Starting with version v0.7.0 lima can manage the networking daemons automatically. Networks are defined in
+`$LIMA_HOME/_config/networks.yaml`. If this file doesn't already exist, it will be created with these default
+settings:
+
+```yaml
+# Paths to vde executables. Because vde_vmnet is invoked via sudo it should be
+# installed where only root can modify/replace it. This means also none of the
+# parent directories should be writable by the user.
+#
+# The varRun directory also must not be writable by the user because it will
+# include the vde_vmnet pid files. Those will be terminated via sudo, so replacing
+# the pid files would allow killing of arbitrary privileged processes. varRun
+# however MUST be writable by the daemon user.
+#
+# None of the paths segments may be symlinks, why it has to be /private/var
+# instead of /var etc.
+paths:
+  vdeSwitch: /opt/vde/bin/vde_switch
+  vdeVMNet: /opt/vde/bin/vde_vmnet
+  varRun: /private/var/run/lima
+  sudoers: /private/etc/sudoers.d/lima
+
+group: staff
+
+networks:
+  shared:
+    mode: shared
+    gateway: 192.168.105.1
+    dhcpEnd: 192.168.105.254
+    netmask: 255.255.255.0
+  bridged:
+    mode: bridged
+    interface: en0
+    # bridged mode doesn't have a gateway; dhcp is managed by outside network
+  host:
+    mode: host
+    gateway: 192.168.106.1
+    dhcpEnd: 192.168.106.254
+    netmask: 255.255.255.0
+```
+
+Instances can then reference these networks from their `lima.yaml` file:
+
+```yaml
+networks:
+  # Lima can manage daemons for networks defined in $LIMA_HOME/_config/networks.yaml
+  # automatically. Both vde_switch and vde_vmnet binaries must be installed into
+  # secure locations only alterable by the "root" user.
+  # - lima: shared
+  #   # 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 "lima0", "lima1", etc.
+  #   interface: ""
+```
+
+The network daemons are started automatically when the first instance referencing them is started,
+and will stop automatically once the last instance has stopped. Daemon logs will be stored in the
+`$LIMA_HOME/_networks` directory.
+
+Since the commands to start and stop the `vde_vmnet` daemon requires root, the user either must
+have password-less `sudo` enabled, or add the required commands to a `sudoers` file. This can
+be done via:
+
+```shell
+limactl sudoers | sudo tee /etc/sudoers.d/lima
+```

examples/vmnet.yaml

@@ -14,10 +14,9 @@ ssh:
   # (TODO: assign localPort automatically)
   localPort: 60105
 
-network:
+networks:
   # 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:
-    - vnl: "vde:///var/run/vde.ctl"
+  # https://github.com/lima-vm/vde_vmnet. Available networks are defined in
+  # $LIMA_HOME/_config/networks.yaml. Supported network types are "host",
+  # "shared", or "bridged".
+- lima: shared

pkg/cidata/cidata.TEMPLATE.d/network-config

@@ -1,12 +1,12 @@
 version: 2
 ethernets:
   {{- range $nw := .Networks}}
-  {{$nw.Name}}:
+  {{$nw.Interface}}:
     match:
       macaddress: '{{$nw.MACAddress}}'
     dhcp4: true
-    set-name: {{$nw.Name}}
-    {{- if and (eq $nw.Name $.SlirpNICName) (gt (len $.DNSAddresses) 0) }}
+    set-name: {{$nw.Interface}}
+    {{- if and (eq $nw.Interface $.SlirpNICName) (gt (len $.DNSAddresses) 0) }}
     nameservers:
       addresses:
       {{- range $ns := $.DNSAddresses }}

pkg/cidata/cidata.go

@@ -16,7 +16,7 @@ import (
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/localpathutil"
 	"github.com/lima-vm/lima/pkg/osutil"
-	"github.com/lima-vm/lima/pkg/qemu/qemuconst"
+	"github.com/lima-vm/lima/pkg/qemu/const"
 	"github.com/lima-vm/lima/pkg/sshutil"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/opencontainers/go-digest"
@@ -35,7 +35,7 @@ var (
 )
 
 func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML) error {
-	if err := limayaml.Validate(*y); err != nil {
+	if err := limayaml.Validate(*y, false); err != nil {
 		return err
 	}
 	u, err := osutil.LimaUser(true)
@@ -51,9 +51,9 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML) error {
 		User:         u.Username,
 		UID:          uid,
 		Containerd:   Containerd{System: *y.Containerd.System, User: *y.Containerd.User},
-		SlirpNICName: qemuconst.SlirpNICName,
-		SlirpGateway: qemuconst.SlirpGateway,
-		SlirpDNS:     qemuconst.SlirpDNS,
+		SlirpNICName: qemu.SlirpNICName,
+		SlirpGateway: qemu.SlirpGateway,
+		SlirpDNS:     qemu.SlirpDNS,
 		Env:          y.Env,
 	}
 
@@ -77,9 +77,9 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML) error {
 	}
 
 	slirpMACAddress := limayaml.MACAddress(instDir)
-	args.Networks = append(args.Networks, Network{MACAddress: slirpMACAddress, Name: qemuconst.SlirpNICName})
-	for _, vde := range y.Network.VDE {
-		args.Networks = append(args.Networks, Network{MACAddress: vde.MACAddress, Name: vde.Name})
+	args.Networks = append(args.Networks, Network{MACAddress: slirpMACAddress, Interface: qemu.SlirpNICName})
+	for _, nw := range y.Networks {
+		args.Networks = append(args.Networks, Network{MACAddress: nw.MACAddress, Interface: nw.Interface})
 	}
 
 	if len(y.DNS) > 0 {