Skip to content

Commit 4817244

Browse files
committed
Add support for multiple attached ISOs per Instance in templates documentation
1 parent 3df7828 commit 4817244

1 file changed

Lines changed: 61 additions & 1 deletion

File tree

source/adminguide/templates.rst

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,16 @@ can also attach ISO images to Guest Instances. For example, this enables
447447
installing PV drivers into Windows. ISO images are not
448448
hypervisor-specific.
449449

450+
A single Instance can hold more than one attached ISO simultaneously, with
451+
each ISO appearing as its own CD-ROM drive inside the guest. This is useful,
452+
for example, when installing Windows on a KVM Instance that uses VirtIO disks
453+
- the Windows installer ISO and the VirtIO drivers ISO can both be attached
454+
at the same time so the installer can load the drivers without an ISO swap.
455+
456+
..
457+
SCREENSHOT NEEDED: Instance detail page -> ISO tab showing two attached ISOs
458+
each listed with its slot label tag (e.g. "hdc", "hdd").
459+
450460
.. _adding-an-iso:
451461
Adding an ISO
452462
-------------
@@ -571,10 +581,60 @@ Attaching an ISO to a Instance
571581

572582
#. Click the Attach ISO button. |iso.png|
573583

574-
#. In the Attach ISO dialog box, select the desired ISO.
584+
#. In the Attach ISO dialog box, select one or more ISOs.
575585

576586
#. Click OK.
577587

588+
..
589+
SCREENSHOT NEEDED: Multi-select Attach ISO dialog with the "ISO name (X / N)"
590+
counter visible and one or two ISOs selected from the dropdown.
591+
592+
The number of CD-ROM drives a single Instance may have is bounded by the
593+
global setting ``vm.cdrom.max.count`` (default ``1``) and by the hypervisor's
594+
own limit. The effective maximum for an Instance is the smaller of the two.
595+
596+
On KVM with the default ``i440fx`` machine type, the IDE bus has four device
597+
slots in total - the root disk takes one, and the remaining usable slots map
598+
to ``hdc`` and ``hdd``, giving a practical maximum of **2** CD-ROMs per
599+
Instance regardless of how high ``vm.cdrom.max.count`` is set.
600+
601+
When multiple ISOs are attached, the first one occupies the bootable
602+
``hdc`` slot and is the one the firmware will try to boot from first.
603+
Subsequent attachments are placed in the next free slots (``hdd``, etc.).
604+
The Attach ISO action is hidden from the Instance's action menu once the
605+
Instance has reached its effective maximum.
606+
607+
The same multi-ISO behavior is available via the ``attachIso`` API. Each
608+
call attaches one ISO into the next free slot; attempting to attach the
609+
same ISO twice, or to attach beyond the effective maximum, returns an
610+
error.
611+
612+
Detaching an ISO
613+
----------------
614+
615+
#. In the left navigation, click Instances.
616+
617+
#. Choose the Instance you want to work with.
618+
619+
#. Click the Detach ISO button.
620+
621+
#. In the Detach ISO dialog box, select one or more ISOs to detach.
622+
623+
#. Click OK.
624+
625+
..
626+
SCREENSHOT NEEDED: Multi-select Detach ISO dialog showing two attached ISOs
627+
with their slot labels (e.g. "Rocky 8.4 boot (hdc)", "dummy (hdd)").
628+
629+
The dialog lists each currently attached ISO alongside the CD-ROM slot it
630+
occupies (``hdc``, ``hdd``, ...) so the right one can be picked. When only
631+
one ISO is attached, it is pre-selected and the user can simply click OK.
632+
633+
The ``detachIso`` API accepts an optional ``id`` parameter naming the ISO
634+
to detach. The parameter may be omitted when only one ISO is attached
635+
(preserving the legacy single-ISO behavior); it is required when multiple
636+
ISOs are attached, otherwise the call is rejected.
637+
578638

579639

580640
.. |sysmanager.png| image:: /_static/images/sysmanager.png

0 commit comments

Comments
 (0)