Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
Updates links to broadcom.com sites, as needed.

Signed-off-by: Ryan Johnson <[email protected]>
  • Loading branch information
tenthirtyam committed May 10, 2024
1 parent ac740b1 commit 78c4bc4
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 23 deletions.
4 changes: 2 additions & 2 deletions .web-docs/components/builder/vsphere-clone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ can be done via environment variable:
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->

- `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.

Expand Down Expand Up @@ -839,7 +839,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)
Expand Down
6 changes: 3 additions & 3 deletions .web-docs/components/builder/vsphere-iso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -878,7 +878,7 @@ 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
Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) for the list
of supported virtual machine hardware versions.

- `guest_os_type` (string) - Specifies the guest operating system identifier for the virtual machine.
Expand Down Expand Up @@ -1343,7 +1343,7 @@ Minimal example of usage to import a OVF template:
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->

- `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.

Expand Down
2 changes: 1 addition & 1 deletion .web-docs/components/post-processor/vsphere/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ 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
See [KB 1003746](https://knowledge.broadcom.com/external/article?articleNumber=315655) for more information on the
virtual hardware versions supported.

- `max_retries` (int) - Specifies the maximum number of times to retry the upload operation if it fails.
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 provider supports versions in accordance with the [Broadcom Product Lifecycle][product-lifecycle].

- [Go 1.19][golang-install]

Expand Down Expand Up @@ -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
6 changes: 3 additions & 3 deletions builder/vsphere/common/step_config_params.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
}

Expand Down
2 changes: 1 addition & 1 deletion builder/vsphere/common/step_hardware.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion builder/vsphere/iso/step_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ 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
// Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) for the list
// of supported virtual machine hardware versions.
Version uint `mapstructure:"vm_version"`
// Specifies the guest operating system identifier for the virtual machine.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->

- `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.

<!-- End of code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; -->
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- `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
Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655) for the list
of supported virtual machine hardware versions.

- `guest_os_type` (string) - Specifies the guest operating system identifier for the virtual machine.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
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
See [KB 1003746](https://knowledge.broadcom.com/external/article?articleNumber=315655) for more information on the
virtual hardware versions supported.

- `max_retries` (int) - Specifies the maximum number of times to retry the upload operation if it fails.
Expand Down
2 changes: 1 addition & 1 deletion post-processor/vsphere/post-processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ 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
// See [KB 1003746](https://knowledge.broadcom.com/external/article?articleNumber=315655) for more information on the
// virtual hardware versions supported.
HardwareVersion string `mapstructure:"hardware_version"`
// Specifies the maximum number of times to retry the upload operation if it fails.
Expand Down

0 comments on commit 78c4bc4

Please sign in to comment.