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.

Sign up for GitHub

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

Clarify options for clone and iso builder (#67) #68

Merged
merged 3 commits into from
Mar 1, 2022
Merged

Clarify options for clone and iso builder (#67) #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d8f483
clarificate options for clone and iso builder (#67)
mabeett Feb 23, 2022
01b27a1
doc typo
mabeett Feb 23, 2022
9a1a517
documentation about boot_key_interval argument
mabeett Feb 23, 2022
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
61 changes: 59 additions & 2 deletions docs/builders/clone.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ in the image's Cloud-Init settings for provisioning.
Can also be set via the `PROXMOX_URL` environment variable.

- `username` (string) - Username when authenticating to Proxmox, including
the realm. For example `user@pve` to use the local Proxmox realm.
When used with `token`, it would look like this: `user@pve!token`
the realm. For example `user@pve` to use the local Proxmox realm. When using
token authentication, the username must include the token id after an exclamation
mark. For example, `user@pve!tokenid`.
Can also be set via the `PROXMOX_USERNAME` environment variable.

- `password` (string) - Password for the user.
Expand Down Expand Up @@ -188,6 +189,11 @@ in the image's Cloud-Init settings for provisioning.
`raw`, `cow`, `qcow`, `qed`, `qcow2`, `vmdk` or `cloop`. Defaults to
`raw`.

- `io_thread` (bool) - Create one I/O thread per storage controller, rather
than a single thread for all I/O. This can increase performance when
multiple disks are used. Requires `virtio-scsi-single` controller and a
`scsi` or `virtio` disk. Defaults to `false`.

- `template_name` (string) - Name of the template. Defaults to the generated
name used during creation.

Expand All @@ -197,12 +203,63 @@ in the image's Cloud-Init settings for provisioning.
- `onboot` (boolean) - Specifies whether a VM will be started during system
bootup. Defaults to `false`.

- `qemu_agent` (boolean) - Enables QEMU Agent option for this VM. When enabled,
then `qemu-guest-agent` must be installed on the guest. When disabled, then
`ssh_host` should be used. Defaults to `true`.

- `disable_kvm` (boolean) - Disables KVM hardware virtualization. Defaults to `false`.

- `scsi_controller` (string) - The SCSI controller model to emulate. Can be `lsi`,
`lsi53c810`, `virtio-scsi-pci`, `virtio-scsi-single`, `megasas`, or `pvscsi`.
Defaults to `lsi`.

- `cloud_init` (bool) - If true, add a Cloud-Init CDROM drive after the virtual machine has been converted to a template.
Defaults to `false`.

- `cloud_init_storage_pool` - (string) - Name of the Proxmox storage pool
to store the Cloud-Init CDROM on. If not given, the storage pool of the boot device will be used.

- `additional_iso_files` (array of objects) - Additional ISO files attached to the virtual machine.
Example:

```json
[
{
"device": "scsi5",
"iso_file": "local:iso/virtio-win-0.1.185.iso",
"unmount": true,
"iso_checksum": "af2b3cc9fa7905dea5e58d31508d75bba717c2b0d5553962658a47aebc9cc386"
}
]
```

- `device` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ideX`,
`sataX` or `scsiX`.
For `ide` the bus index ranges from 0 to 3, for `sata` form 0 to 5 and for
`scsi` from 0 to 30.
Defaults to `ide3` since `ide2` is generally the boot drive.

- `iso_file` (string) - Path to the ISO file to boot from, expressed as a
proxmox datastore path, for example
`local:iso/Fedora-Server-dvd-x86_64-29-1.2.iso`.
Either `iso_file` OR `iso_url` must be specifed.

- `iso_url` (string) - URL to an ISO file to upload to Proxmox, and then
boot from. Either `iso_file` OR `iso_url` must be specifed.

- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_checksum` (string) - Checksum of the ISO file.
- `unmount` (bool) - If true, remove the mounted ISO from the template after finishing. Defaults to `false`.

- `http_interface` - (string) - Name of the network interface that Packer gets
`HTTPIP` from. Defaults to the first non loopback interface.

- `vm_interface` - (string) - Name of the network interface that Packer gets
the VMs IP from. Defaults to the first non loopback interface.


- `full_clone` (bool) - Whether to run a full or shallow clone from the base clone_vm. Defaults to `true`.

- `boot` - (string) - Override default boot order. Format example `order=virtio0;ide2;net0`.
Expand Down
15 changes: 12 additions & 3 deletions docs/builders/iso.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ In addition to the options listed here, a
[communicator](/docs/templates/legacy_json_templates/communicator) can be configured for this
builder.

If no communicator is defined, an SSH key is generated for use, and is used
in the image's Cloud-Init settings for provisioning.

### Required:

- `proxmox_url` (string) - URL to the Proxmox API, including the full path,
Expand Down Expand Up @@ -81,6 +84,9 @@ builder.

- `insecure_skip_tls_verify` (bool) - Skip validating the certificate.

- `task_timeout` (duration string | ex: "10m") - The timeout for
Promox API operations, e.g. clones. Defaults to 1 minute.

- `pool` (string) - Name of resource pool to create virtual machine in.

- `vm_name` (string) - Name of the virtual machine during creation. If not
Expand Down Expand Up @@ -145,7 +151,8 @@ builder.
`e1000-82544gc` or `e1000-82545em`. Defaults to `e1000`.

- `mac_address` (string) - Give the adapter a specific MAC address. If
not set, defaults to a random MAC.
not set, defaults to a random MAC. If value is "repeatable", value of MAC
address is deterministic based on VM ID and NIC ID.

- `vlan_tag` (string) - If the adapter should tag packets. Defaults to
no tagging.
Expand Down Expand Up @@ -222,7 +229,7 @@ builder.

- `scsi_controller` (string) - The SCSI controller model to emulate. Can be `lsi`,
`lsi53c810`, `virtio-scsi-pci`, `virtio-scsi-single`, `megasas`, or `pvscsi`.
Defaults to `lsi`.f
Defaults to `lsi`.

- `cloud_init` (bool) - If true, add a Cloud-Init CDROM drive after the virtual machine has been converted to a template.
Defaults to `false`.
Expand Down Expand Up @@ -291,7 +298,9 @@ are all typed in sequence. It is an array only to improve readability within
the template.

The boot command is "typed" character for character over the virtual keyboard
to the machine, simulating a human actually typing the keyboard.
to the machine, simulating a human actually typing the keyboard. The time
between keystrokes may be configured with `boot_key_interval`, the default
value is 15ms.

<!-- Code generated from the comments of the BootConfig struct in bootcommand/config.go; DO NOT EDIT MANUALLY -->

Expand Down