Skip to content

Commit 29c0fb9

Browse files
mpywelllbajolet-hashicorp
authored andcommitted
common: update documentation of ISOsConfig Type field
1 parent fd411ab commit 29c0fb9

File tree

4 files changed

+24
-12
lines changed

4 files changed

+24
-12
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -668,9 +668,12 @@ In HCL2:
668668

669669
<!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
670670

671-
- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
672-
`sata` or `scsi`.
673-
Defaults to `ide`.
671+
- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
672+
673+
In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
674+
they are configured, using free bus indexes after disks are attached.
675+
Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
676+
as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
674677

675678
- `iso_file` (string) - Path to the ISO file to boot from, expressed as a
676679
proxmox datastore path, for example

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,12 @@ HCL2 example:
331331

332332
<!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
333333

334-
- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
335-
`sata` or `scsi`.
336-
Defaults to `ide`.
334+
- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
335+
336+
In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
337+
they are configured, using free bus indexes after disks are attached.
338+
Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
339+
as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
337340

338341
- `iso_file` (string) - Path to the ISO file to boot from, expressed as a
339342
proxmox datastore path, for example

builder/proxmox/common/config.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,12 @@ type Config struct {
237237
// ```
238238
type ISOsConfig struct {
239239
commonsteps.ISOConfig `mapstructure:",squash"`
240-
// Bus type and bus index that the ISO will be mounted on. Can be `ide`,
241-
// `sata` or `scsi`.
242-
// Defaults to `ide`.
240+
// Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
241+
//
242+
// In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
243+
// they are configured, using free bus indexes after disks are attached.
244+
// Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
245+
// as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
243246
Type string `mapstructure:"type"`
244247
// Path to the ISO file to boot from, expressed as a
245248
// proxmox datastore path, for example

docs-partials/builder/proxmox/common/ISOsConfig-not-required.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
22

3-
- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
4-
`sata` or `scsi`.
5-
Defaults to `ide`.
3+
- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
4+
5+
In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
6+
they are configured, using free bus indexes after disks are attached.
7+
Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
8+
as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
69

710
- `iso_file` (string) - Path to the ISO file to boot from, expressed as a
811
proxmox datastore path, for example

0 commit comments

Comments
 (0)