diff --git a/.web-docs/README.md b/.web-docs/README.md index 8b8f4a36..2057cd07 100644 --- a/.web-docs/README.md +++ b/.web-docs/README.md @@ -5,15 +5,16 @@ The vSphere plugin is able to create vSphere virtual machines for use with VMwar To achieve this, the plugin comes with three builders, and two post-processors to build the virtual machine depending on the strategy you want to use. -The Packer Plugin for VMware vSphere is a multi-component plugin can be used with -HashiCorp Packer to create virtual machine images for VMware vSphere. +The Packer Plugin for VMware vSphere is a multi-component plugin can be used with HashiCorp Packer +to create virtual machine images for VMware vSphere. The plugin includes three builders which are able to create images, depending on your desired strategy: ### Installation -To install this plugin add this code into your Packer configuration and run [packer init](/packer/docs/commands/init) +To install this plugin add this code into your Packer configuration and run +[packer init](/packer/docs/commands/init) ```hcl packer { @@ -50,13 +51,13 @@ packer plugins install github.com/hashicorp/vsphere #### Post-Processors -- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) - This - post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA, or OVF - file. +- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) - + This post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA, + or OVF file. - [vsphere-template](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere-template) - This post-processor uses an artifact from the `vmware-iso` builder with an ESXi host or an - artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It - then marks the virtual machine as a template and moves it to your specified path. + artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It + then marks the virtual machine as a template and moves it to your specified path. ### Differences from the Packer Plugin for VMware diff --git a/.web-docs/components/builder/vsphere-clone/README.md b/.web-docs/components/builder/vsphere-clone/README.md index 354d67ed..67bf1e3a 100644 --- a/.web-docs/components/builder/vsphere-clone/README.md +++ b/.web-docs/components/builder/vsphere-clone/README.md @@ -278,12 +278,12 @@ can be done via environment variable: - `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's - ConfigSpec: https://vdc-download.vmware.com/vmwb-repository/dcr-public/bf660c0a-f060-46e8-a94d-4b5e6ffc77ad/208bc706-e281-49b6-a0ce-b402ec19ef82/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.ConfigSpec.html + [VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/) - `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false. -- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle. - If not set, defaults to manual upgrade. +- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware + Tools upon a system power cycle. If not set, defaults to manual upgrade. @@ -880,7 +880,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg for supported maximums. Defaults to 1. - `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for - virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) + virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) - `vgpu_profile` (string) - vGPU profile for accelerated graphics. vGPU profile for accelerated graphics. See [NVIDIA GRID vGPU documentation](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#configure-vmware-vsphere-vm-with-vgpu) diff --git a/.web-docs/components/builder/vsphere-iso/README.md b/.web-docs/components/builder/vsphere-iso/README.md index f51b526c..f1c67b10 100644 --- a/.web-docs/components/builder/vsphere-iso/README.md +++ b/.web-docs/components/builder/vsphere-iso/README.md @@ -417,7 +417,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg for supported maximums. Defaults to 1. - `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for - virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) + virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) - `vgpu_profile` (string) - vGPU profile for accelerated graphics. vGPU profile for accelerated graphics. See [NVIDIA GRID vGPU documentation](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#configure-vmware-vsphere-vm-with-vgpu) @@ -878,8 +878,8 @@ boot time. - `vm_version` (uint) - Specifies the virtual machine hardware version. Defaults to the most current virtual machine hardware version supported by the ESXi host. - Refer to [VMware KB article 1003746](https://kb.vmware.com/s/article/1003746) for the list - of supported virtual machine hardware versions. + Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + for more information on supported virtual hardware versions. - `guest_os_type` (string) - Specifies the guest operating system identifier for the virtual machine. If not specified, the setting defaults to `otherGuest`. @@ -1343,12 +1343,12 @@ Minimal example of usage to import a OVF template: - `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's - ConfigSpec: https://vdc-download.vmware.com/vmwb-repository/dcr-public/bf660c0a-f060-46e8-a94d-4b5e6ffc77ad/208bc706-e281-49b6-a0ce-b402ec19ef82/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.ConfigSpec.html + [VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/) - `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false. -- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle. - If not set, defaults to manual upgrade. +- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware + Tools upon a system power cycle. If not set, defaults to manual upgrade. diff --git a/.web-docs/components/post-processor/vsphere/README.md b/.web-docs/components/post-processor/vsphere/README.md index c0bc043a..ce281075 100644 --- a/.web-docs/components/post-processor/vsphere/README.md +++ b/.web-docs/components/post-processor/vsphere/README.md @@ -71,8 +71,8 @@ Optional: This option is useful when deploying to vCenter Server instance ot an ESXi host whose version is different than the one used to create the artifact. - See [VMware KB 1003746](https://kb.vmware.com/s/article/1003746) for more information on the - virtual hardware versions supported. + Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + for more information on supported virtual hardware versions. - `max_retries` (int) - Specifies the maximum number of times to retry the upload operation if it fails. Defaults to `5`. diff --git a/README.md b/README.md index adfe7cc9..c3a6598d 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,7 @@ Please refer to the documentation for each plugin to understand the specific cap - [VMware vSphere][docs-vsphere] - The provider supports versions in accordance with the VMware Product Lifecycle Matrix from - General Availability to End of General Support. - - Learn more: [VMware Product Lifecycle Matrix][vmware-product-lifecycle-matrix] + The plugin supports versions in accordance with the [Broadcom Product Lifecycle][product-lifecycle]. - [Go 1.19][golang-install] @@ -133,4 +130,4 @@ For more information on how to configure the plugin, please see the [plugin docu [golang-install]: https://golang.org/doc/install [packer]: https://www.packer.io [releases-vsphere-plugin]: https://github.com/hashicorp/packer-plugin-vsphere/releases -[vmware-product-lifecycle-matrix]: https://lifecycle.vmware.com +[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle diff --git a/builder/vsphere/common/step_config_params.go b/builder/vsphere/common/step_config_params.go index 8c9845c5..5f9fac5d 100644 --- a/builder/vsphere/common/step_config_params.go +++ b/builder/vsphere/common/step_config_params.go @@ -19,14 +19,14 @@ import ( type ConfigParamsConfig struct { // configuration_parameters is a direct passthrough to the vSphere API's - // ConfigSpec: https://vdc-download.vmware.com/vmwb-repository/dcr-public/bf660c0a-f060-46e8-a94d-4b5e6ffc77ad/208bc706-e281-49b6-a0ce-b402ec19ef82/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.ConfigSpec.html + // [VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/) ConfigParams map[string]string `mapstructure:"configuration_parameters"` // Enables time synchronization with the host. Defaults to false. ToolsSyncTime bool `mapstructure:"tools_sync_time"` - // If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle. - // If not set, defaults to manual upgrade. + // If sets to true, vSphere will automatically check and upgrade VMware + // Tools upon a system power cycle. If not set, defaults to manual upgrade. ToolsUpgradePolicy bool `mapstructure:"tools_upgrade_policy"` } diff --git a/builder/vsphere/common/step_hardware.go b/builder/vsphere/common/step_hardware.go index ce01782d..5444c84e 100644 --- a/builder/vsphere/common/step_hardware.go +++ b/builder/vsphere/common/step_hardware.go @@ -86,7 +86,7 @@ type HardwareConfig struct { // for supported maximums. Defaults to 1. Displays int32 `mapstructure:"displays"` // Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for - // virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) + // virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) AllowedDevices []PCIPassthroughAllowedDevice `mapstructure:"pci_passthrough_allowed_device"` // vGPU profile for accelerated graphics. // vGPU profile for accelerated graphics. See [NVIDIA GRID vGPU documentation](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#configure-vmware-vsphere-vm-with-vgpu) diff --git a/builder/vsphere/iso/step_create.go b/builder/vsphere/iso/step_create.go index e2a80ddc..b2067647 100644 --- a/builder/vsphere/iso/step_create.go +++ b/builder/vsphere/iso/step_create.go @@ -81,8 +81,8 @@ type NIC struct { type CreateConfig struct { // Specifies the virtual machine hardware version. Defaults to the most current virtual machine // hardware version supported by the ESXi host. - // Refer to [VMware KB article 1003746](https://kb.vmware.com/s/article/1003746) for the list - // of supported virtual machine hardware versions. + // Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + // for more information on supported virtual hardware versions. Version uint `mapstructure:"vm_version"` // Specifies the guest operating system identifier for the virtual machine. // If not specified, the setting defaults to `otherGuest`. diff --git a/docs-partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx b/docs-partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx index 11af52a1..17fc648b 100644 --- a/docs-partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx +++ b/docs-partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx @@ -1,11 +1,11 @@ - `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's - ConfigSpec: https://vdc-download.vmware.com/vmwb-repository/dcr-public/bf660c0a-f060-46e8-a94d-4b5e6ffc77ad/208bc706-e281-49b6-a0ce-b402ec19ef82/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.ConfigSpec.html + [VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/) - `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false. -- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle. - If not set, defaults to manual upgrade. +- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware + Tools upon a system power cycle. If not set, defaults to manual upgrade. diff --git a/docs-partials/builder/vsphere/common/HardwareConfig-not-required.mdx b/docs-partials/builder/vsphere/common/HardwareConfig-not-required.mdx index 64b481ba..b2205772 100644 --- a/docs-partials/builder/vsphere/common/HardwareConfig-not-required.mdx +++ b/docs-partials/builder/vsphere/common/HardwareConfig-not-required.mdx @@ -26,7 +26,7 @@ for supported maximums. Defaults to 1. - `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for - virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) + virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html) - `vgpu_profile` (string) - vGPU profile for accelerated graphics. vGPU profile for accelerated graphics. See [NVIDIA GRID vGPU documentation](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#configure-vmware-vsphere-vm-with-vgpu) diff --git a/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx b/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx index b85c1329..7ffa521d 100644 --- a/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx +++ b/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx @@ -2,8 +2,8 @@ - `vm_version` (uint) - Specifies the virtual machine hardware version. Defaults to the most current virtual machine hardware version supported by the ESXi host. - Refer to [VMware KB article 1003746](https://kb.vmware.com/s/article/1003746) for the list - of supported virtual machine hardware versions. + Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + for more information on supported virtual hardware versions. - `guest_os_type` (string) - Specifies the guest operating system identifier for the virtual machine. If not specified, the setting defaults to `otherGuest`. diff --git a/docs-partials/post-processor/vsphere/Config-not-required.mdx b/docs-partials/post-processor/vsphere/Config-not-required.mdx index 117f1d7d..3d04caa4 100644 --- a/docs-partials/post-processor/vsphere/Config-not-required.mdx +++ b/docs-partials/post-processor/vsphere/Config-not-required.mdx @@ -36,8 +36,8 @@ This option is useful when deploying to vCenter Server instance ot an ESXi host whose version is different than the one used to create the artifact. - See [VMware KB 1003746](https://kb.vmware.com/s/article/1003746) for more information on the - virtual hardware versions supported. + Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + for more information on supported virtual hardware versions. - `max_retries` (int) - Specifies the maximum number of times to retry the upload operation if it fails. Defaults to `5`. diff --git a/docs/README.md b/docs/README.md index 8b8f4a36..2057cd07 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,15 +5,16 @@ The vSphere plugin is able to create vSphere virtual machines for use with VMwar To achieve this, the plugin comes with three builders, and two post-processors to build the virtual machine depending on the strategy you want to use. -The Packer Plugin for VMware vSphere is a multi-component plugin can be used with -HashiCorp Packer to create virtual machine images for VMware vSphere. +The Packer Plugin for VMware vSphere is a multi-component plugin can be used with HashiCorp Packer +to create virtual machine images for VMware vSphere. The plugin includes three builders which are able to create images, depending on your desired strategy: ### Installation -To install this plugin add this code into your Packer configuration and run [packer init](/packer/docs/commands/init) +To install this plugin add this code into your Packer configuration and run +[packer init](/packer/docs/commands/init) ```hcl packer { @@ -50,13 +51,13 @@ packer plugins install github.com/hashicorp/vsphere #### Post-Processors -- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) - This - post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA, or OVF - file. +- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) - + This post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA, + or OVF file. - [vsphere-template](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere-template) - This post-processor uses an artifact from the `vmware-iso` builder with an ESXi host or an - artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It - then marks the virtual machine as a template and moves it to your specified path. + artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It + then marks the virtual machine as a template and moves it to your specified path. ### Differences from the Packer Plugin for VMware diff --git a/post-processor/vsphere/post-processor.go b/post-processor/vsphere/post-processor.go index d8a3b663..06bbc992 100644 --- a/post-processor/vsphere/post-processor.go +++ b/post-processor/vsphere/post-processor.go @@ -96,8 +96,8 @@ type Config struct { // This option is useful when deploying to vCenter Server instance ot an ESXi host whose // version is different than the one used to create the artifact. // - // See [VMware KB 1003746](https://kb.vmware.com/s/article/1003746) for more information on the - // virtual hardware versions supported. + // Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) + // for more information on supported virtual hardware versions. HardwareVersion string `mapstructure:"hardware_version"` // Specifies the maximum number of times to retry the upload operation if it fails. // Defaults to `5`.