Merge pull request #2790 from jandubois/guestagent-debug

Pass limactl start --debug flag to guest agent

Author: jandubois

pkg/cidata/cidata.TEMPLATE.d/boot/25-guestagent-base.sh

@@ -35,7 +35,7 @@ name="lima-guestagent"
 description="Forward ports to the lima-hostagent"
 
 command=${LIMA_CIDATA_GUEST_INSTALL_PREFIX}/bin/lima-guestagent
-command_args="daemon --vsock-port \"${LIMA_CIDATA_VSOCK_PORT}\" --virtio-port \"${LIMA_CIDATA_VIRTIO_PORT}\""
+command_args="daemon --debug=${LIMA_CIDATA_DEBUG} --vsock-port \"${LIMA_CIDATA_VSOCK_PORT}\" --virtio-port \"${LIMA_CIDATA_VIRTIO_PORT}\""
 command_background=true
 pidfile="/run/lima-guestagent.pid"
 EOF

pkg/cidata/cidata.TEMPLATE.d/lima.env

@@ -1,3 +1,4 @@
+LIMA_CIDATA_DEBUG={{ .Debug }}
 LIMA_CIDATA_NAME={{ .Name }}
 LIMA_CIDATA_USER={{ .User }}
 LIMA_CIDATA_UID={{ .UID }}

pkg/cidata/cidata.go

@@ -16,6 +16,7 @@ import (
 	"time"
 
 	"github.com/docker/go-units"
+	"github.com/lima-vm/lima/pkg/debugutil"
 	"github.com/lima-vm/lima/pkg/iso9660util"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/localpathutil"
@@ -124,6 +125,7 @@ func templateArgs(bootScripts bool, instDir, name string, instConfig *limayaml.L
 		return nil, err
 	}
 	args := TemplateArgs{
+		Debug:              debugutil.Debug,
 		BootScripts:        bootScripts,
 		Name:               name,
 		User:               u.Username,

pkg/cidata/template.go

@@ -54,6 +54,7 @@ type Disk struct {
 	FSArgs []string
 }
 type TemplateArgs struct {
+	Debug                           bool
 	Name                            string // instance name
 	IID                             string // instance id
 	User                            string // user name

website/content/en/docs/dev/internals/_index.md

@@ -174,6 +174,7 @@ Max file name length = 30
 The volume label is "cidata", as defined by [cloud-init NoCloud](https://docs.cloud-init.io/en/latest/reference/datasources/nocloud.html).
 
 ### Environment variables
+- `LIMA_CIDATA_DEBUG`: the value of the `--debug` flag of the `limactl start` command.
 - `LIMA_CIDATA_NAME`: the lima instance name
 - `LIMA_CIDATA_MNT`: the mount point of the disk. `/mnt/lima-cidata`.
 - `LIMA_CIDATA_USER`: the username string