Skip to content

Commit f5faf82

Browse files
tenthirtyamlbajolet-hashicorp
authored andcommitted
docs: update links
Updates links to broadcom.com sites, as needed. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent e53e401 commit f5faf82

14 files changed

Lines changed: 48 additions & 49 deletions

File tree

.web-docs/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ The vSphere plugin is able to create vSphere virtual machines for use with VMwar
55
To achieve this, the plugin comes with three builders, and two post-processors to build the virtual
66
machine depending on the strategy you want to use.
77

8-
The Packer Plugin for VMware vSphere is a multi-component plugin can be used with
9-
HashiCorp Packer to create virtual machine images for VMware vSphere.
8+
The Packer Plugin for VMware vSphere is a multi-component plugin can be used with HashiCorp Packer
9+
to create virtual machine images for VMware vSphere.
1010

1111
The plugin includes three builders which are able to create images, depending on your desired
1212
strategy:
1313

1414
### Installation
1515

16-
To install this plugin add this code into your Packer configuration and run [packer init](/packer/docs/commands/init)
16+
To install this plugin add this code into your Packer configuration and run
17+
[packer init](/packer/docs/commands/init)
1718

1819
```hcl
1920
packer {
@@ -50,13 +51,13 @@ packer plugins install github.com/hashicorp/vsphere
5051

5152
#### Post-Processors
5253

53-
- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) - This
54-
post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA, or OVF
55-
file.
54+
- [vsphere](/packer/integrations/hashicorp/vsphere/latest/components/post-processor/vsphere) -
55+
This post-processor uploads an artifact to a vSphere endpoint. The artifact must be a VMX, OVA,
56+
or OVF file.
5657

5758
- [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
58-
artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It
59-
then marks the virtual machine as a template and moves it to your specified path.
59+
artifact from the [vSphere](/packer/plugins/post-processors/vsphere/vsphere) post-processor. It
60+
then marks the virtual machine as a template and moves it to your specified path.
6061

6162
### Differences from the Packer Plugin for VMware
6263

.web-docs/components/builder/vsphere-clone/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,12 +278,12 @@ can be done via environment variable:
278278
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
279279

280280
- `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's
281-
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
281+
[VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/)
282282

283283
- `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false.
284284

285-
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle.
286-
If not set, defaults to manual upgrade.
285+
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware
286+
Tools upon a system power cycle. If not set, defaults to manual upgrade.
287287

288288
<!-- End of code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; -->
289289

@@ -880,7 +880,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
880880
for supported maximums. Defaults to 1.
881881

882882
- `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for
883-
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)
883+
virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html)
884884

885885
- `vgpu_profile` (string) - vGPU profile for accelerated graphics.
886886
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)

.web-docs/components/builder/vsphere-iso/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
417417
for supported maximums. Defaults to 1.
418418

419419
- `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for
420-
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)
420+
virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html)
421421

422422
- `vgpu_profile` (string) - vGPU profile for accelerated graphics.
423423
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.
878878

879879
- `vm_version` (uint) - Specifies the virtual machine hardware version. Defaults to the most current virtual machine
880880
hardware version supported by the ESXi host.
881-
Refer to [VMware KB article 1003746](https://kb.vmware.com/s/article/1003746) for the list
882-
of supported virtual machine hardware versions.
881+
Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655)
882+
for more information on supported virtual hardware versions.
883883

884884
- `guest_os_type` (string) - Specifies the guest operating system identifier for the virtual machine.
885885
If not specified, the setting defaults to `otherGuest`.
@@ -1343,12 +1343,12 @@ Minimal example of usage to import a OVF template:
13431343
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
13441344

13451345
- `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's
1346-
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
1346+
[VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/)
13471347

13481348
- `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false.
13491349

1350-
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle.
1351-
If not set, defaults to manual upgrade.
1350+
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware
1351+
Tools upon a system power cycle. If not set, defaults to manual upgrade.
13521352

13531353
<!-- End of code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; -->
13541354

.web-docs/components/post-processor/vsphere/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Optional:
7171
This option is useful when deploying to vCenter Server instance ot an ESXi host whose
7272
version is different than the one used to create the artifact.
7373

74-
See [VMware KB 1003746](https://kb.vmware.com/s/article/1003746) for more information on the
75-
virtual hardware versions supported.
74+
Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655)
75+
for more information on supported virtual hardware versions.
7676

7777
- `max_retries` (int) - Specifies the maximum number of times to retry the upload operation if it fails.
7878
Defaults to `5`.

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@ Please refer to the documentation for each plugin to understand the specific cap
5555

5656
- [VMware vSphere][docs-vsphere]
5757

58-
The provider supports versions in accordance with the VMware Product Lifecycle Matrix from
59-
General Availability to End of General Support.
60-
61-
Learn more: [VMware Product Lifecycle Matrix][vmware-product-lifecycle-matrix]
58+
The plugin supports versions in accordance with the [Broadcom Product Lifecycle][product-lifecycle].
6259

6360
- [Go 1.19][golang-install]
6461

@@ -133,4 +130,4 @@ For more information on how to configure the plugin, please see the [plugin docu
133130
[golang-install]: https://golang.org/doc/install
134131
[packer]: https://www.packer.io
135132
[releases-vsphere-plugin]: https://github.com/hashicorp/packer-plugin-vsphere/releases
136-
[vmware-product-lifecycle-matrix]: https://lifecycle.vmware.com
133+
[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle

builder/vsphere/common/step_config_params.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ import (
1919

2020
type ConfigParamsConfig struct {
2121
// configuration_parameters is a direct passthrough to the vSphere API's
22-
// 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
22+
// [VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/)
2323
ConfigParams map[string]string `mapstructure:"configuration_parameters"`
2424

2525
// Enables time synchronization with the host. Defaults to false.
2626
ToolsSyncTime bool `mapstructure:"tools_sync_time"`
2727

28-
// If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle.
29-
// If not set, defaults to manual upgrade.
28+
// If sets to true, vSphere will automatically check and upgrade VMware
29+
// Tools upon a system power cycle. If not set, defaults to manual upgrade.
3030
ToolsUpgradePolicy bool `mapstructure:"tools_upgrade_policy"`
3131
}
3232

builder/vsphere/common/step_hardware.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ type HardwareConfig struct {
8686
// for supported maximums. Defaults to 1.
8787
Displays int32 `mapstructure:"displays"`
8888
// Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for
89-
// 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)
89+
// virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html)
9090
AllowedDevices []PCIPassthroughAllowedDevice `mapstructure:"pci_passthrough_allowed_device"`
9191
// vGPU profile for accelerated graphics.
9292
// 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)

builder/vsphere/iso/step_create.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ type NIC struct {
8181
type CreateConfig struct {
8282
// Specifies the virtual machine hardware version. Defaults to the most current virtual machine
8383
// hardware version supported by the ESXi host.
84-
// Refer to [VMware KB article 1003746](https://kb.vmware.com/s/article/1003746) for the list
85-
// of supported virtual machine hardware versions.
84+
// Refer to [KB 315655](https://knowledge.broadcom.com/external/article?articleNumber=315655)
85+
// for more information on supported virtual hardware versions.
8686
Version uint `mapstructure:"vm_version"`
8787
// Specifies the guest operating system identifier for the virtual machine.
8888
// If not specified, the setting defaults to `otherGuest`.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
22

33
- `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's
4-
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
4+
[VirtualMachineConfigSpec](https://developer.broadcom.com/xapis/virtual-infrastructure-json-api/8.0.2.0/data-structures/VirtualMachineConfigSpec/)
55

66
- `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false.
77

8-
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle.
9-
If not set, defaults to manual upgrade.
8+
- `tools_upgrade_policy` (bool) - If sets to true, vSphere will automatically check and upgrade VMware
9+
Tools upon a system power cycle. If not set, defaults to manual upgrade.
1010

1111
<!-- End of code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; -->

docs-partials/builder/vsphere/common/HardwareConfig-not-required.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
for supported maximums. Defaults to 1.
2727

2828
- `pci_passthrough_allowed_device` ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O [PCI Passthrough](#pci-passthrough-configuration) for
29-
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)
29+
virtual machine. See [vSphere documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-5B3CAB26-5D06-4A99-92A0-3A04C69CE64B.html)
3030

3131
- `vgpu_profile` (string) - vGPU profile for accelerated graphics.
3232
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)

0 commit comments

Comments
 (0)