Support ansible provision mode for remote playbook

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

Author: afbjorklund

pkg/cidata/cidata.go

@@ -334,6 +334,8 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 			})
 		case limayaml.ProvisionModeBoot:
 			continue
+		case limayaml.ProvisionModeAnsible:
+			continue
 		default:
 			return fmt.Errorf("unknown provision mode %q", f.Mode)
 		}

pkg/limayaml/limayaml.go

@@ -180,12 +180,14 @@ const (
 	ProvisionModeUser       ProvisionMode = "user"
 	ProvisionModeBoot       ProvisionMode = "boot"
 	ProvisionModeDependency ProvisionMode = "dependency"
+	ProvisionModeAnsible    ProvisionMode = "ansible"
 )
 
 type Provision struct {
 	Mode                            ProvisionMode `yaml:"mode" json:"mode"` // default: "system"
 	SkipDefaultDependencyResolution *bool         `yaml:"skipDefaultDependencyResolution,omitempty" json:"skipDefaultDependencyResolution,omitempty"`
 	Script                          string        `yaml:"script" json:"script"`
+	Playbook                        string        `yaml:"playbook,omitempty" json:"playbook,omitempty"`
 }
 
 type Containerd struct {

pkg/limayaml/validate.go

@@ -183,9 +183,10 @@ func Validate(y LimaYAML, warn bool) error {
 					i, ProvisionModeDependency)
 			}
 		case ProvisionModeDependency:
+		case ProvisionModeAnsible:
 		default:
-			return fmt.Errorf("field `provision[%d].mode` must one of %q, %q, %q, or %q",
-				i, ProvisionModeSystem, ProvisionModeUser, ProvisionModeBoot, ProvisionModeDependency)
+			return fmt.Errorf("field `provision[%d].mode` must one of %q, %q, %q, %q, or %q",
+				i, ProvisionModeSystem, ProvisionModeUser, ProvisionModeBoot, ProvisionModeDependency, ProvisionModeAnsible)
 		}
 		if strings.Contains(p.Script, "LIMA_CIDATA") {
 			logrus.Warn("provisioning scripts should not reference the LIMA_CIDATA variables")

pkg/start/ansible.go

@@ -0,0 +1,66 @@
+package start
+
+import (
+	"context"
+	"os"
+	"os/exec"
+	"path/filepath"
+
+	"github.com/goccy/go-yaml"
+	"github.com/lima-vm/lima/pkg/limayaml"
+	"github.com/lima-vm/lima/pkg/store"
+	"github.com/lima-vm/lima/pkg/store/filenames"
+	"github.com/sirupsen/logrus"
+)
+
+func runAnsibleProvision(ctx context.Context, inst *store.Instance) error {
+	y, err := inst.LoadYAML()
+	if err != nil {
+		return err
+	}
+	for _, f := range y.Provision {
+		if f.Mode == limayaml.ProvisionModeAnsible {
+			logrus.Infof("Waiting for ansible playbook %q", f.Playbook)
+			if err := runAnsiblePlaybook(ctx, inst, f.Playbook); err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}
+
+func runAnsiblePlaybook(ctx context.Context, inst *store.Instance, playbook string) error {
+	inventory, err := createInventory(inst)
+	if err != nil {
+		return err
+	}
+	logrus.Debugf("ansible-playbook -i %q %q", inventory, playbook)
+	args := []string{"-i", inventory, playbook}
+	cmd := exec.CommandContext(ctx, "ansible-playbook", args...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	return cmd.Run()
+}
+
+func createInventory(inst *store.Instance) (string, error) {
+	vars := map[string]interface{}{
+		"ansible_connection":      "ssh",
+		"ansible_host":            "lima-" + inst.Name,
+		"ansible_ssh_common_args": "-F " + inst.SSHConfigFile,
+	}
+	hosts := map[string]interface{}{
+		inst.Name: vars,
+	}
+	group := "lima"
+	data := map[string]interface{}{
+		group: map[string]interface{}{
+			"hosts": hosts,
+		},
+	}
+	bytes, err := yaml.Marshal(data)
+	if err != nil {
+		return "", err
+	}
+	inventory := filepath.Join(inst.Dir, filenames.InventoryYAML)
+	return inventory, os.WriteFile(inventory, bytes, 0o644)
+}

pkg/start/start.go

@@ -291,6 +291,10 @@ func watchHostAgentEvents(ctx context.Context, inst *store.Instance, haStdoutPat
 				return true
 			}
 
+			if xerr := runAnsibleProvision(ctx, inst); xerr != nil {
+				err = xerr
+				return true
+			}
 			if *inst.Config.Plain {
 				logrus.Infof("READY. Run `ssh -F %q lima-%s` to open the shell.", inst.SSHConfigFile, inst.Name)
 			} else {

pkg/store/filenames/filenames.go

@@ -56,6 +56,7 @@ const (
 	VzIdentifier       = "vz-identifier"
 	VzEfi              = "vz-efi"           // efi variable store
 	QemuEfiCodeFD      = "qemu-efi-code.fd" // efi code; not always created
+	InventoryYAML      = "inventory.yaml"   // ansible inventory
 
 	// SocketDir is the default location for forwarded sockets with a relative paths in HostSocket
 	SocketDir = "sock"