fix: configuration parameters

[tenthirtyam]

Summary

Updates to the documentation, improvements to logging, and enhancements to error handling in the vsphere builder components. The most important changes include adding examples to the documentation, improving logging for configuration parameters, and enhancing error handling during VM reconfiguration.

Documentation Updates:

• .web-docs/components/builder/vsphere-clone/README.md: Added HCL and JSON examples for configuration_parameters and notes on ignored keys.
• .web-docs/components/builder/vsphere-iso/README.md: Added HCL and JSON examples for configuration_parameters and notes on ignored keys.
• docs-partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx: Added HCL and JSON examples for configuration_parameters and notes on ignored keys.

Logging Enhancements:

• builder/vsphere/common/step_config_params.go: Added logging for each key-value pair in configuration_parameters.

Error Handling Improvements:

• builder/vsphere/driver/vm.go: Enhanced error messages and added logging for ignored configuration parameters during VM reconfiguration.

Testing

Configuration:

  configuration_parameters = {
    "svga.autodetect"        = "TRUE"
    "logging"                = "FALSE"
    "disk.EnableUUID"        = "TRUE"
    "log.keepOld"            = "15"
    "migrate.encryptionMode" = "required"
  }

Log:

2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Adding: svga.autodetect = TRUE
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Adding: logging = FALSE
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Adding: disk.EnableUUID = TRUE
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Adding: log.keepOld = 15
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Adding: migrate.encryptionMode = required
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Reconfiguration task completed successfully.
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Ignored the following parameters: [migrate.encryptionMode = required , logging = FALSE]
2024/09/25 19:51:52 packer-plugin-vsphere_v1.4.1-dev_x5.0_darwin_arm64 plugin: 2024/09/25 19:51:52 [INFO] Some configuration keys were ignored due to conflicts with other fields in the ConfigSpec. Refer to VirtualMachineConfigSpec in the vSphere API documentation.

Reference

Ref: #467

[lbajolet-hashicorp]

LGTM! Thanks @tenthirtyam