common: update documentation of ISOsConfig Type field

hashicorp · Jun 20, 2024 · e635f0e · e635f0e
1 parent 6b51d75
commit e635f0e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 12 deletions.
diff --git a/.web-docs/components/builder/clone/README.md b/.web-docs/components/builder/clone/README.md
@@ -668,9 +668,12 @@ In HCL2:
 
 <!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
 
-- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
-  `sata` or `scsi`.
-  Defaults to `ide`.
+- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
+
+  In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
+  they are configured, using free bus indexes after disks are attached.
+  Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
+  as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
 
 - `iso_file` (string) - Path to the ISO file to boot from, expressed as a
   proxmox datastore path, for example

diff --git a/.web-docs/components/builder/iso/README.md b/.web-docs/components/builder/iso/README.md
@@ -331,9 +331,12 @@ HCL2 example:
 
 <!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
 
-- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
-  `sata` or `scsi`.
-  Defaults to `ide`.
+- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
+
+  In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
+  they are configured, using free bus indexes after disks are attached.
+  Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
+  as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
 
 - `iso_file` (string) - Path to the ISO file to boot from, expressed as a
   proxmox datastore path, for example

diff --git a/builder/proxmox/common/config.go b/builder/proxmox/common/config.go
@@ -237,9 +237,12 @@ type Config struct {
 // ```
 type ISOsConfig struct {
 	commonsteps.ISOConfig `mapstructure:",squash"`
-	// Bus type and bus index that the ISO will be mounted on. Can be `ide`,
-	// `sata` or `scsi`.
-	// Defaults to `ide`.
+	// Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
+	//
+	// In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
+	// they are configured, using free bus indexes after disks are attached.
+	// Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
+	// as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
 	Type string `mapstructure:"type"`
 	// Path to the ISO file to boot from, expressed as a
 	// proxmox datastore path, for example

diff --git a/docs-partials/builder/proxmox/common/ISOsConfig-not-required.mdx b/docs-partials/builder/proxmox/common/ISOsConfig-not-required.mdx
@@ -1,8 +1,11 @@
 <!-- Code generated from the comments of the ISOsConfig struct in builder/proxmox/common/config.go; DO NOT EDIT MANUALLY -->
 
-- `type` (string) - Bus type and bus index that the ISO will be mounted on. Can be `ide`,
-  `sata` or `scsi`.
-  Defaults to `ide`.
+- `type` (string) - Bus type that the ISO will be mounted on. Can be `ide`, `sata` or `scsi`. Defaults to `ide`.
+
+  In v1.9 bus indexes are no longer accepted for ISOs. ISOs are now attached to VMs in the order
+  they are configured, using free bus indexes after disks are attached.
+  Example: if two Disks and one ISO are defined as type `sata`, the disks will be attached to the VM
+  as `sata0`, `sata1`, and the ISO will be mapped to `sata2` (the next free device index)
 
 - `iso_file` (string) - Path to the ISO file to boot from, expressed as a
   proxmox datastore path, for example