Apply additional reviews

- `boot.sh`:
  - Remove TODO
  - Reword WARNING
- `default.yaml`:
  - Reword comments
  - Add provision processing order information
- `validateParamIsUsed`: Remove some comments

Signed-off-by: Norio Nomura <[email protected]>

Author: norio-nomura

pkg/cidata/cidata.TEMPLATE.d/boot.sh

@@ -69,7 +69,6 @@ if [ -d "${LIMA_CIDATA_MNT}"/provision.data ]; then
 			INFO "Not overwriting $path"
 		else
 			INFO "Copying $f to $path"
-			# TODO: Create intermediate directories with the specified group ownership.
 			if ! sudo -iu "${user}" mkdir -p "$(dirname "$path")"; then
 				WARNING "Failed to create directory for ${path} (as user ${user})"
 				WARNING "Falling back to creating directory as root to maintain compatibility"
@@ -106,7 +105,7 @@ if [ -d "${LIMA_CIDATA_MNT}"/provision.yq ]; then
 			# If the user does not have write permission, it should fail.
 			# This avoids changes being made by the wrong user.
 			if ! sudo -iu "${user}" test -w "${path}"; then
-				WARNING "Failed to update ${path} (as user ${user})"
+				WARNING "File ${path} is not writable by user ${user}"
 				CODE=1
 				continue
 			fi

pkg/limayaml/validate.go

@@ -496,13 +496,7 @@ func validateParamIsUsed(y *limatype.LimaYAML) error {
 		}
 		keyIsUsed := false
 		for _, p := range y.Provision {
-			for _, ptr := range []*string{
-				&p.Script,
-				// mode: data
-				p.Content, p.Owner, p.Path,
-				// mode: yq
-				p.Expression, p.Permissions,
-			} {
+			for _, ptr := range []*string{&p.Script, p.Content, p.Expression, p.Owner, p.Path, p.Permissions} {
 				if ptr != nil && re.MatchString(*ptr) {
 					keyIsUsed = true
 					break

templates/default.yaml

@@ -247,10 +247,11 @@ containerd:
 #   permissions: 644
 #   overwrite: false
 # # Create or edit a file in the guest filesystem by using `yq`.
-# # The file specified by `path` will be updated with the specified `expression` using `yq --inplace`.
-# # If the file does not exist, it will be created using `yq --null-input`.
-# # `format` is optional and defaults to "auto".
-# # One of the following is expected to work:
+# # The file specified by `path` will be updated by `expression`.
+# # An empty file of the required `format` will be created if it does not yet exist.
+# # `format` defaults to "auto" and will be detected by file extension of `path`.
+# # If the extension is not recognized by `yq` then `format` must be set to a
+# # value from this list:
 # #   "auto", "csv", "ini", "json", "props", "tsv", "toml", "xml", "yaml"
 # # See https://github.com/mikefarah/yq for more info.
 # # Any missing directories will be created as needed.
@@ -265,6 +266,29 @@ containerd:
 #   format: auto
 #   owner: "{{.User}}"
 #   permissions: 644
+#
+# Q. In what order are provision scripts executed?
+# A. All provisions are processed per boot by each module in stages of cloud-init as follows:
+#   1. cloud-init 'init' stage
+#     bootcmd:
+#     - `mode: boot` scripts are executed
+#
+#   2. cloud-init 'config' stage
+#     write_files:
+#     - `00-lima.boot.sh` is created, but not executed
+#
+#   3. cloud-init 'final' stage
+#     scripts_per_boot:
+#     - `00-lima.boot.sh` is executed; remaining provisions are processed in the following order:
+#       - LIMA pre-defined boot scripts:
+#         - `boot/{00-..., ..., 25-...}`
+#         - `boot/30-install-packages.sh`
+#           - `mode: dependency` scripts are executed
+#         - `boot/{35-..., ...}`
+#       - `mode: data` files are copied
+#       - `mode: yq` files are processed
+#       - `mode: system` scripts are executed
+#       - `mode: user` scripts are executed
 
 # Probe scripts to check readiness.
 # The scripts run in user mode. They must start with a '#!' line.