Merge pull request #1094 from pendo324/bootCmds

add "boot" provisioning script mode

Author: jandubois

examples/default.yaml

@@ -171,6 +171,12 @@ containerd:
 #     cat <<EOF > ~/.vimrc
 #     set number
 #     EOF
+# # `boot` is executed directly by /bin/sh as part of cloud-init-local.service's early boot process,
+# # which is why there is no hash-bang specified in the example
+# # See cloud-init docs for more info https://cloudinit.readthedocs.io/en/latest/topics/examples.html#run-commands-on-first-boot
+# - mode: boot
+#   script: |
+#     systemctl disable NetworkManager-wait-online.service
 
 # Probe scripts to check readiness.
 # 🟢 Builtin default: null

pkg/cidata/cidata.TEMPLATE.d/user-data

@@ -64,3 +64,13 @@ ca-certs:
     {{- end }}
   {{- end }}
 {{- end }}
+
+{{- if .BootCmds }}
+bootcmd:
+  {{- range $cmd := $.BootCmds }}
+- |
+    {{- range $line := $cmd.Lines }}
+  {{ $line }}
+    {{- end }}
+  {{- end }}
+{{- end }}

pkg/cidata/cidata.go

@@ -219,6 +219,8 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 		args.CACerts.Trusted = append(args.CACerts.Trusted, cert)
 	}
 
+	args.BootCmds = getBootCmds(y.Provision)
+
 	if err := ValidateTemplateArgs(args); err != nil {
 		return err
 	}
@@ -235,6 +237,8 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 				Path:   fmt.Sprintf("provision.%s/%08d", f.Mode, i),
 				Reader: strings.NewReader(f.Script),
 			})
+		case limayaml.ProvisionModeBoot:
+			continue
 		default:
 			return fmt.Errorf("unknown provision mode %q", f.Mode)
 		}
@@ -289,3 +293,20 @@ func getCert(content string) Cert {
 	// return lines
 	return Cert{Lines: lines}
 }
+
+func getBootCmds(p []limayaml.Provision) []BootCmds {
+	var bootCmds []BootCmds
+	for _, f := range p {
+		if f.Mode == limayaml.ProvisionModeBoot {
+			lines := []string{}
+			for _, line := range strings.Split(f.Script, "\n") {
+				if line == "" {
+					continue
+				}
+				lines = append(lines, strings.TrimSpace(line))
+			}
+			bootCmds = append(bootCmds, BootCmds{Lines: lines})
+		}
+	}
+	return bootCmds
+}

pkg/cidata/template.go

@@ -42,6 +42,9 @@ type Mount struct {
 	Type       string
 	Options    string
 }
+type BootCmds struct {
+	Lines []string
+}
 type TemplateArgs struct {
 	Name               string // instance name
 	IID                string // instance id
@@ -62,6 +65,7 @@ type TemplateArgs struct {
 	DNSAddresses       []string
 	CACerts            CACerts
 	HostHomeMountPoint string
+	BootCmds           []BootCmds
 }
 
 func ValidateTemplateArgs(args TemplateArgs) error {

pkg/limayaml/limayaml.go

@@ -116,6 +116,7 @@ type ProvisionMode = string
 const (
 	ProvisionModeSystem ProvisionMode = "system"
 	ProvisionModeUser   ProvisionMode = "user"
+	ProvisionModeBoot   ProvisionMode = "boot"
 )
 
 type Provision struct {

pkg/limayaml/validate.go

@@ -153,10 +153,10 @@ func Validate(y LimaYAML, warn bool) error {
 
 	for i, p := range y.Provision {
 		switch p.Mode {
-		case ProvisionModeSystem, ProvisionModeUser:
+		case ProvisionModeSystem, ProvisionModeUser, ProvisionModeBoot:
 		default:
-			return fmt.Errorf("field `provision[%d].mode` must be either %q or %q",
-				i, ProvisionModeSystem, ProvisionModeUser)
+			return fmt.Errorf("field `provision[%d].mode` must be either %q, %q, or %q",
+				i, ProvisionModeSystem, ProvisionModeUser, ProvisionModeBoot)
 		}
 	}
 	needsContainerdArchives := (y.Containerd.User != nil && *y.Containerd.User) || (y.Containerd.System != nil && *y.Containerd.System)