Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update links #429

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions .web-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions .web-docs/components/builder/vsphere-clone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,12 +272,12 @@ 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.

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

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
12 changes: 6 additions & 6 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,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`.
Expand Down Expand Up @@ -1343,12 +1343,12 @@ 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.

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

Expand Down
4 changes: 2 additions & 2 deletions .web-docs/components/post-processor/vsphere/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
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 plugin 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
4 changes: 2 additions & 2 deletions builder/vsphere/iso/step_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
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,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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
17 changes: 9 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions post-processor/vsphere/post-processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down