Allow changing prefix for the installations

If /usr/local is read-only, you can override the prefix to use something
like /opt instead. But it is assumed that /etc is always read-write...

Signed-off-by: Anders F Björklund <[email protected]>

Author: afbjorklund

examples/default.yaml

@@ -158,6 +158,10 @@ caCerts:
   #   YOUR-ORGS-TRUSTED-CA-CERT-HERE
   #   -----END CERTIFICATE-----
 
+# Prefix to use for installing guest agent, and containerd with dependencies (if configured)
+# 🟢 Builtin default: /usr/local
+guestInstallPrefix: null
+
 containerd:
   # Enable system-wide (aka rootful)  containerd and its dependencies (BuildKit, Stargz Snapshotter)
   # Note that `nerdctl.lima` only works in rootless mode; you have to use `lima sudo nerdctl ...`

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

@@ -15,7 +15,7 @@ if [ "${LIMA_CIDATA_MOUNTTYPE}" = "reverse-sshfs" ]; then
 fi
 
 # Install or update the guestagent binary
-install -m 755 "${LIMA_CIDATA_MNT}"/lima-guestagent /usr/local/bin/lima-guestagent
+install -m 755 "${LIMA_CIDATA_MNT}"/lima-guestagent "${LIMA_CIDATA_PREFIX}"/bin/lima-guestagent
 
 # Launch the guestagent service
 if [ -f /sbin/openrc-run ]; then
@@ -27,7 +27,7 @@ supervisor=supervise-daemon
 name="lima-guestagent"
 description="Forward ports to the lima-hostagent"
 
-command=/usr/local/bin/lima-guestagent
+command=${LIMA_CIDATA_PREFIX}/bin/lima-guestagent
 command_args="daemon"
 command_background=true
 pidfile="/run/lima-guestagent.pid"
@@ -40,5 +40,5 @@ else
 	# Remove legacy systemd service
 	rm -f "/home/${LIMA_CIDATA_USER}.linux/.config/systemd/user/lima-guestagent.service"
 
-	sudo /usr/local/bin/lima-guestagent install-systemd
+	sudo "${LIMA_CIDATA_PREFIX}"/bin/lima-guestagent install-systemd
 fi

pkg/cidata/cidata.TEMPLATE.d/boot/40-install-containerd.sh

@@ -13,18 +13,18 @@ command -v systemctl >/dev/null 2>&1 || exit 0
 tmp_extract_nerdctl="$(mktemp -d)"
 tar Cxzf "${tmp_extract_nerdctl}" "${LIMA_CIDATA_MNT}"/nerdctl-full.tgz bin/nerdctl
 
-if [ ! -f /usr/local/bin/nerdctl ] || [[ "${tmp_extract_nerdctl}"/bin/nerdctl -nt /usr/local/bin/nerdctl ]]; then
-	if [ -f /usr/local/bin/nerdctl ]; then
+if [ ! -f "${LIMA_CIDATA_PREFIX}"/bin/nerdctl ] || [[ "${tmp_extract_nerdctl}"/bin/nerdctl -nt "${LIMA_CIDATA_PREFIX}"/bin/nerdctl ]]; then
+	if [ -f "${LIMA_CIDATA_PREFIX}"/bin/nerdctl ]; then
 		(
 			set +e
 			echo "Upgrading existing nerdctl"
-			echo "- Old: $(/usr/local/bin/nerdctl --version)"
+			echo "- Old: $("${LIMA_CIDATA_PREFIX}"/bin/nerdctl --version)"
 			echo "- New: $("${tmp_extract_nerdctl}"/bin/nerdctl --version)"
 			systemctl disable --now containerd buildkit stargz-snapshotter
 			sudo -iu "${LIMA_CIDATA_USER}" "XDG_RUNTIME_DIR=/run/user/${LIMA_CIDATA_UID}" "PATH=${PATH}" containerd-rootless-setuptool.sh uninstall
 		)
 	fi
-	tar Cxzf /usr/local "${LIMA_CIDATA_MNT}"/nerdctl-full.tgz
+	tar Cxzf "${LIMA_CIDATA_PREFIX}" "${LIMA_CIDATA_MNT}"/nerdctl-full.tgz
 
 	mkdir -p /etc/bash_completion.d
 	nerdctl completion bash >/etc/bash_completion.d/nerdctl

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

@@ -12,6 +12,7 @@ LIMA_CIDATA_DISKS={{ len .Disks }}
 LIMA_CIDATA_DISK_{{$i}}_NAME={{$disk.Name}}
 LIMA_CIDATA_DISK_{{$i}}_DEVICE={{$disk.Device}}
 {{- end}}
+LIMA_CIDATA_PREFIX={{ .Prefix }}
 {{- if .Containerd.User}}
 LIMA_CIDATA_CONTAINERD_USER=1
 {{- else}}

pkg/cidata/cidata.go

@@ -121,6 +121,7 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 		Name:           name,
 		User:           u.Username,
 		UID:            uid,
+		Prefix:         *y.Prefix,
 		Containerd:     Containerd{System: *y.Containerd.System, User: *y.Containerd.User},
 		SlirpNICName:   networks.SlirpNICName,
 		SlirpGateway:   networks.SlirpGateway,

pkg/cidata/template.go

@@ -58,6 +58,7 @@ type TemplateArgs struct {
 	Mounts                          []Mount
 	MountType                       string
 	Disks                           []Disk
+	Prefix                          string
 	Containerd                      Containerd
 	Networks                        []Network
 	SlirpNICName                    string

pkg/hostagent/requirements.go

@@ -158,7 +158,7 @@ are set to 'false' in the config file.
 				description: "containerd binaries to be installed",
 				script: `#!/bin/bash
 set -eux -o pipefail
-if ! timeout 30s bash -c "until command -v nerdctl; do sleep 3; done"; then
+if ! timeout 30s bash -c "until command -v nerdctl || test -x ` + *a.y.Prefix + `/bin/nerdctl; do sleep 3; done"; then
 	echo >&2 "nerdctl is not installed yet"
 	exit 1
 fi

pkg/limayaml/defaults.go

@@ -108,6 +108,10 @@ func defaultDiskSizeAsString() string {
 	return "100GiB"
 }
 
+func defaultPrefix() string {
+	return "/usr/local"
+}
+
 // FillDefault updates undefined fields in y with defaults from d (or built-in default), and overwrites with values from o.
 // Both d and o may be empty.
 //
@@ -346,6 +350,16 @@ func FillDefault(y, d, o *LimaYAML, filePath string) {
 		}
 	}
 
+	if y.Prefix == nil {
+		y.Prefix = d.Prefix
+	}
+	if o.Prefix != nil {
+		y.Prefix = o.Prefix
+	}
+	if y.Prefix == nil {
+		y.Prefix = pointer.String(defaultPrefix())
+	}
+
 	if y.Containerd.System == nil {
 		y.Containerd.System = d.Containerd.System
 	}

pkg/limayaml/defaults_test.go

@@ -71,6 +71,7 @@ func TestFillDefault(t *testing.T) {
 		CPUs:   pointer.Int(defaultCPUs()),
 		Memory: pointer.String(defaultMemoryAsString()),
 		Disk:   pointer.String(defaultDiskSizeAsString()),
+		Prefix: pointer.String(defaultPrefix()),
 		Containerd: Containerd{
 			System:   pointer.Bool(false),
 			User:     pointer.Bool(true),
@@ -278,6 +279,7 @@ func TestFillDefault(t *testing.T) {
 		AdditionalDisks: []Disk{
 			"data",
 		},
+		Prefix: pointer.String("/opt"),
 		Containerd: Containerd{
 			System: pointer.Bool(true),
 			User:   pointer.Bool(false),
@@ -454,6 +456,7 @@ func TestFillDefault(t *testing.T) {
 		AdditionalDisks: []Disk{
 			"test",
 		},
+		Prefix: pointer.String("/usr"),
 		Containerd: Containerd{
 			System: pointer.Bool(true),
 			User:   pointer.Bool(false),

pkg/limayaml/limayaml.go

@@ -23,6 +23,7 @@ type LimaYAML struct {
 	Video           Video           `yaml:"video,omitempty" json:"video,omitempty"`
 	Provision       []Provision     `yaml:"provision,omitempty" json:"provision,omitempty"`
 	Containerd      Containerd      `yaml:"containerd,omitempty" json:"containerd,omitempty"`
+	Prefix          *string         `yaml:"guestInstallPrefix,omitempty" json:"guestInstallPrefix,omitempty"`
 	Probes          []Probe         `yaml:"probes,omitempty" json:"probes,omitempty"`
 	PortForwards    []PortForward   `yaml:"portForwards,omitempty" json:"portForwards,omitempty"`
 	CopyToHost      []CopyToHost    `yaml:"copyToHost,omitempty" json:"copyToHost,omitempty"`