Deprecate the ansible provision mode and playbook

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

Author: afbjorklund

pkg/limayaml/limayaml.go

@@ -221,7 +221,7 @@ const (
 	ProvisionModeUser       ProvisionMode = "user"
 	ProvisionModeBoot       ProvisionMode = "boot"
 	ProvisionModeDependency ProvisionMode = "dependency"
-	ProvisionModeAnsible    ProvisionMode = "ansible"
+	ProvisionModeAnsible    ProvisionMode = "ansible" // DEPRECATED
 	ProvisionModeData       ProvisionMode = "data"
 )
 
@@ -230,7 +230,7 @@ type Provision struct {
 	SkipDefaultDependencyResolution *bool              `yaml:"skipDefaultDependencyResolution,omitempty" json:"skipDefaultDependencyResolution,omitempty"`
 	Script                          string             `yaml:"script" json:"script"`
 	File                            *LocatorWithDigest `yaml:"file,omitempty" json:"file,omitempty" jsonschema:"nullable"`
-	Playbook                        string             `yaml:"playbook,omitempty" json:"playbook,omitempty"`
+	Playbook                        string             `yaml:"playbook,omitempty" json:"playbook,omitempty"` // DEPRECATED
 	// All ProvisionData fields must be nil unless Mode is ProvisionModeData
 	ProvisionData `yaml:",inline"` // Flatten fields for "strict" YAML mode
 }

pkg/limayaml/validate.go

@@ -277,6 +277,7 @@ func Validate(y *LimaYAML, warn bool) error {
 			if _, err := os.Stat(playbook); err != nil {
 				return fmt.Errorf("field `provision[%d].playbook` refers to an inaccessible path: %q: %w", i, playbook, err)
 			}
+			logrus.Warnf("provision mode %q is deprecated, use `ansible-playbook %q` instead", ProvisionModeAnsible, playbook)
 		}
 		if strings.Contains(p.Script, "LIMA_CIDATA") {
 			logrus.Warn("provisioning scripts should not reference the LIMA_CIDATA variables")

templates/default.yaml

@@ -230,6 +230,8 @@ containerd:
 # # It requires `ansible-playbook` command to be installed.
 # # Environment variables such as ANSIBLE_CONFIG can be used, to control the behavior of the playbook execution.
 # # See ansible docs, and `ansible-config`, for more info https://docs.ansible.com/ansible/latest/playbook_guide/
+# # DEPRECATED The ansible mode is deprecated, and should not be used. Instead call ansible-playbook directly,
+# # either from the host after the instance is started or from the instance by running ansible locally instead.
 # - mode: ansible
 #   playbook: playbook.yaml
 # # `data` is a file that is written to the guest filesystem and not executed at all.

website/content/en/docs/releases/deprecated.md

@@ -9,6 +9,7 @@ The following features are deprecated:
 - Loading non-strict YAMLs (i.e., YAMLs with unknown properties)
 - `limactl show-ssh` command (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
 - `LIMA_SSH_PORT_FORWARDER=true` (since Lima v1.1)
+- Ansible provisioning mode (Use `ansible-playbook playbook.yaml` after the start instead)
 
 ## Removed features
 - YAML property `network`: deprecated in [Lima v0.7.0](https://github.com/lima-vm/lima/commit/07e68230e70b21108d2db3ca5e0efd0e43842fbd)