generated from hashicorp/packer-plugin-scaffolding
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update disk configuration (#225)
Updates the disk configuration documentation for clarity and readability. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
- Loading branch information
1 parent
7fa57d8
commit 087d9a9
Showing
4 changed files
with
107 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 25 additions & 28 deletions
53
docs-partials/builder/vmware/common/DiskConfig-not-required.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,44 @@ | ||
| <!-- Code generated from the comments of the DiskConfig struct in builder/vmware/common/disk_config.go; DO NOT EDIT MANUALLY --> | ||
|
|
||
| - `disk_additional_size` ([]uint) - The size(s) of any additional | ||
| hard disks for the VM in megabytes. If this is not specified then the VM | ||
| will only contain a primary hard disk. The builder uses expandable, not | ||
| fixed-size virtual hard disks, so the actual file representing the disk will | ||
| not use the full size unless it is full. | ||
| - `disk_additional_size` ([]uint) - The size(s) of additional virtual hard disks in MB. If not specified, | ||
| the virtual machine will contain only a primary hard disk. | ||
|
|
||
| - `disk_adapter_type` (string) - The adapter type of the VMware virtual disk to create. This option is | ||
| for advanced usage, modify only if you know what you're doing. Some of | ||
| the options you can specify are `ide`, `sata`, `nvme` or `scsi` (which | ||
| uses the "lsilogic" scsi interface by default). If you specify another | ||
| option, Packer will assume that you're specifying a `scsi` interface of | ||
| that specified type. For more information, please consult [Virtual Disk | ||
| Manager User's Guide](http://www.vmware.com/pdf/VirtualDiskManager.pdf) | ||
| for desktop VMware clients. For ESXi, refer to the proper ESXi | ||
| documentation. | ||
| - `disk_adapter_type` (string) - The adapter type for additional virtual disk(s). Available options | ||
| are `ide`, `sata`, `nvme`, or `scsi`. | ||
|
|
||
| ~> **Note:** When specifying `scsi` as the adapter type, the default | ||
| adapter type is set to `lsilogic`. If another option is specified, the | ||
| plugin will assume it is a `scsi` interface of that specified type. | ||
|
|
||
| ~> **Note:** This option is intended for advanced users. | ||
|
|
||
| - `vmdk_name` (string) - The filename of the virtual disk that'll be created, | ||
| without the extension. This defaults to "disk". | ||
| - `vmdk_name` (string) - The filename for the virtual disk to create _without_ the `.vmdk` | ||
| extension. Defaults to `disk`. | ||
|
|
||
| - `disk_type_id` (string) - The type of VMware virtual disk to create. This | ||
| option is for advanced usage. | ||
| - `disk_type_id` (string) - The type of virtual disk to create. | ||
|
|
||
| For desktop VMware clients: | ||
| For local desktop hypervisors, the available options are: | ||
|
|
||
| Type ID | Description | ||
| ------- | --- | ||
| `0` | Growable virtual disk contained in a single file (monolithic sparse). | ||
| `1` | Growable virtual disk split into 2GB files (split sparse). | ||
| `2` | Preallocated virtual disk contained in a single file (monolithic flat). | ||
| `3` | Preallocated virtual disk split into 2GB files (split flat). | ||
| `4` | Preallocated virtual disk compatible with ESX server (VMFS flat). | ||
| `4` | Preallocated virtual disk compatible with ESXi (VMFS flat). | ||
| `5` | Compressed disk optimized for streaming. | ||
|
|
||
| The default is `1`. | ||
| Defaults to `1`. | ||
|
|
||
| For remote hypervisors, the available options are: `zeroedthick`, | ||
| `eagerzeroedthick`, and `thin`. Defaults to `zeroedthick`. | ||
|
|
||
| ~> **Note:** The `rdm:dev`, `rdmp:dev`, and `2gbsparse` types are not | ||
| supported for remote hypervisors. | ||
|
|
||
| For ESXi, this defaults to `zeroedthick`. The available options for ESXi | ||
| are: `zeroedthick`, `eagerzeroedthick`, `thin`. `rdm:dev`, `rdmp:dev`, | ||
| `2gbsparse` are not supported. Due to default disk compaction, when using | ||
| `zeroedthick` or `eagerzeroedthick` set `skip_compaction` to `true`. | ||
| ~> **Note:** Set `skip_compaction` to `true` when using `zeroedthick` | ||
| or `eagerzeroedthick` due to default disk compaction behavior. | ||
|
|
||
| For more information, please consult the [Virtual Disk Manager User's | ||
| Guide](https://www.vmware.com/pdf/VirtualDiskManager.pdf) for desktop | ||
| VMware clients. For ESXi, refer to the proper ESXi documentation. | ||
| ~> **Note:** This option is intended for advanced users. | ||
|
|
||
| <!-- End of code generated from the comments of the DiskConfig struct in builder/vmware/common/disk_config.go; --> |