VmManager: Allow external iscsi volumes

Core-i99 · Core-i99 · commit 3d2398f0b299 · 2025-11-22T15:48:23.000+01:00
Closes #204
diff --git a/backend/insert_vm_templates.py b/backend/insert_vm_templates.py
@@ -36,6 +36,7 @@ def insert_vm_templates():
     <emulator>{%qemu_path%}</emulator>
     {%devices_disk_file%}
     {%devices_disk_block%}
+    {%devices_disk_iscsi%}
     {%devices_network%}
     <controller type='pci' index='0' model='pcie-root'/>
     <input type='tablet' bus='usb'>
@@ -81,6 +82,7 @@ def insert_vm_templates():
     <emulator>{%qemu_path%}</emulator>
     {%devices_disk_file%}
     {%devices_disk_block%}
+    {%devices_disk_iscsi%}
     {%devices_network%}
     <controller type='pci' index='0' model='pcie-root'/>
     <controller type="usb" index="0" model="ich9-ehci1"/>
diff --git a/backend/vm_manager/routes.py b/backend/vm_manager/routes.py
@@ -3,7 +3,7 @@
 from auth_manager.auth import check_auth
 from db.database import get_session
 from sqlmodel import select
-from .vmbasic import VirtualMachineBasic, VirtualMachineBasicTemplate, OvmfPath, VirtualMachineBasicLibvirtConfig, VirtualMachineXmlTemplate, VirtualMachineDeviceDiskFile, VirtualMachineDeviceNetwork, VirtualMachineDeviceDiskBlock, get_vm_networks
+from .vmbasic import VirtualMachineBasic, VirtualMachineBasicTemplate, OvmfPath, VirtualMachineBasicLibvirtConfig, VirtualMachineXmlTemplate, VirtualMachineDeviceDiskFile, VirtualMachineDeviceNetwork, VirtualMachineDeviceDiskBlock, VirtualMachineDeviceDiskIscsi, get_vm_networks
 
 router = APIRouter()
 
@@ -198,3 +198,25 @@ async def api_vm_add_device_disk_block(vm_id: int, device: VirtualMachineDeviceD
         session.commit()
         return device
     return
+
+@router.delete("/{vm_id}/devices/disk-iscsi/{device_id}")
+async def api_vm_delete_device_disk_iscsi(vm_id: int, device_id: int, username: str = Depends(check_auth)):
+    with get_session() as session:
+        disk_device_iscsi = session.exec(select(VirtualMachineDeviceDiskIscsi).where(VirtualMachineDeviceDiskIscsi.id == device_id)).first()
+        if disk_device_iscsi is None:
+            raise HTTPException(status_code=404, detail="iSCSI disk device not found")
+        session.delete(disk_device_iscsi)
+        session.commit()
+
+@router.post("/{vm_id}/devices/disk-iscsi")
+async def api_vm_add_device_disk_iscsi(vm_id: int, device: VirtualMachineDeviceDiskIscsi, username: str = Depends(check_auth)):
+    print(f"Adding iSCSI disk device {device}")
+    with get_session() as session:
+        vm = session.exec(select(VirtualMachineBasic).where(VirtualMachineBasic.id == vm_id)).first()
+        if vm is None:
+            raise HTTPException(status_code=404, detail="VM not found")
+        device.vm = vm
+        session.add(device)
+        session.commit()
+        return device
+    return
diff --git a/backend/vm_manager/vmbasic.py b/backend/vm_manager/vmbasic.py
@@ -104,6 +104,7 @@ class VirtualMachineBasic(SQLModel, table=True):
     devices_pci: list["VirtualMachineDevicePci"] = Relationship(back_populates="vm")
     devices_disk_file: list["VirtualMachineDeviceDiskFile"] = Relationship(back_populates="vm")
     devices_disk_block: list["VirtualMachineDeviceDiskBlock"] = Relationship(back_populates="vm")
+    devices_disk_iscsi: list["VirtualMachineDeviceDiskIscsi"] = Relationship(back_populates="vm")
     devices_network: list["VirtualMachineDeviceNetwork"] = Relationship(back_populates="vm")
     xml_template_id: int | None = Field(nullable=False, foreign_key="virtualmachinexmltemplate.id")
     xml_template: VirtualMachineXmlTemplate | None = Relationship()
@@ -142,6 +143,18 @@ class VirtualMachineDeviceDiskBlock(SQLModel, table=True):
     vm_id: int | None = Field(foreign_key="virtualmachine.id")
     vm: VirtualMachineBasic | None = Relationship(back_populates="devices_disk_block")
 
+class VirtualMachineDeviceDiskIscsi(SQLModel, table=True):
+    __tablename__ = "virtualmachinedevicediskiscsi"
+    id: int | None = Field(primary_key=True)
+    name: str = Field(nullable=False)
+    disk_bus: str = Field(nullable=False) # VirtualMachineBasicDiskBusTypes
+    device_type: str = Field(nullable=False) # VirtualMachineBasicDiskDeviceTypes
+    iscsi_name: str = Field(nullable=False) # iqn.2013-07.com.example:iscsi-nopool/2
+    iscsi_host: str = Field(nullable=False) # example.com
+    iscsi_port: int = Field(nullable=False, default=3260) # 3260
+    vm_id: int | None = Field(foreign_key="virtualmachine.id")
+    vm: VirtualMachineBasic | None = Relationship(back_populates="devices_disk_iscsi")
+
 class VirtualMachineDeviceNetwork(SQLModel, table=True):
     __tablename__ = "virtualmachinedevicenetwork"
     id: int | None = Field(primary_key=True)
@@ -163,6 +176,7 @@ def to_dict(self):
         vm_dict["devices_pci"] = [device.model_dump() for device in self.vm.devices_pci]
         vm_dict["devices_disk_file"] = [device.model_dump() for device in self.vm.devices_disk_file]
         vm_dict["devices_disk_block"] = [device.model_dump() for device in self.vm.devices_disk_block]
+        vm_dict["devices_disk_iscsi"] = [device.model_dump() for device in self.vm.devices_disk_iscsi]
         vm_dict["devices_network"] = [device.model_dump() for device in self.vm.devices_network]
         return vm_dict
 
@@ -213,6 +227,22 @@ def gen_devices_disk_block(self):
             </disk>"""
         return devices_disk_block
     
+    def gen_devices_disk_iscsi(self):
+        devices_disk_iscsi = ""
+        # Calculate starting index based on number of file and block disks
+        start_index = len(self.vm.devices_disk_file) + len(self.vm.devices_disk_block)
+        for index, device in enumerate(self.vm.devices_disk_iscsi):
+            targetdev = "sd"
+            targetdev += chr(ord("a") + start_index + index)
+            devices_disk_iscsi += f"""<disk type='network' device='{device.device_type}'>
+            <driver name='qemu' type='raw'/>
+            <source protocol='iscsi' name='{device.iscsi_name}'>
+              <host name='{device.iscsi_host}' port='{device.iscsi_port}'/>
+            </source>
+            <target dev='{targetdev}' bus='{device.disk_bus}'/>
+            </disk>"""
+        return devices_disk_iscsi
+    
     def gen_devices_network(self):
         devices_network = ""
         for index, device in enumerate(self.vm.devices_network):
@@ -244,6 +274,7 @@ def gen_xml(self):
         xml = xml.replace("{%qemu_path%}", "/usr/bin/qemu-system-x86_64")
         xml = xml.replace("{%devices_disk_file%}", self.gen_devices_disk_file())
         xml = xml.replace("{%devices_disk_block%}", self.gen_devices_disk_block())
+        xml = xml.replace("{%devices_disk_iscsi%}", self.gen_devices_disk_iscsi())
         xml = xml.replace("{%devices_network%}", self.gen_devices_network())
         xml = xml.replace("{%graphics%}", self.gen_graphics())
         xml = xml.replace("{%video%}", self.gen_video())
diff --git a/frontend/src/components/vm/AddDevice.vue b/frontend/src/components/vm/AddDevice.vue
@@ -33,6 +33,18 @@
             </q-item-section>
             <q-item-section>Disk (Block)</q-item-section>
           </q-item>
+          <q-item
+            clickable
+            v-ripple
+            :active="option === 'disk-iscsi'"
+            @click="option = 'disk-iscsi'"
+            active-class="my-menu-link"
+          >
+            <q-item-section avatar>
+              <q-icon color="primary" name="mdi-harddisk" />
+            </q-item-section>
+            <q-item-section>Disk (iSCSI)</q-item-section>
+          </q-item>
           <q-item
             clickable
             v-ripple
@@ -92,6 +104,44 @@
           hint="Enter the path to the physical disk device"
         />
       </q-card-section>
+      <q-card-section v-if="diskiscsiLayout">
+        <q-input filled v-model="diskIscsiName" label="Disk Name" class="q-pb-md" />
+        <q-select
+          class="q-pb-md"
+          v-model="diskIscsiBusType"
+          :options="diskBusTypes"
+          label="Disk Bus"
+          filled
+        />
+        <q-select
+          class="q-pb-md"
+          v-model="diskIscsiDeviceType"
+          :options="diskDeviceTypes"
+          label="Device Type"
+          filled
+        />
+        <q-input
+          filled
+          v-model="diskIscsiIqn"
+          label="iSCSI Name (IQN)"
+          hint="e.g., iqn.2013-07.com.example:iscsi-nopool/2"
+          class="q-pb-md"
+        />
+        <q-input
+          filled
+          v-model="diskIscsiHost"
+          label="iSCSI Host"
+          hint="e.g., example.com or 192.168.1.100"
+          class="q-pb-md"
+        />
+        <q-input
+          filled
+          v-model="diskIscsiPort"
+          type="number"
+          label="iSCSI Port"
+          hint="Default: 3260"
+        />
+      </q-card-section>
       <q-card-section v-if="networkLayout" class="q-py-none">
         <q-select
           class="q-pb-md"
@@ -128,6 +178,9 @@
         <q-btn color="primary" icon="check" flat @click="diskBlockCreate" v-if="diskblockLayout">
           <ToolTip content="Create" />
         </q-btn>
+        <q-btn color="primary" icon="check" flat @click="diskIscsiCreate" v-if="diskiscsiLayout">
+          <ToolTip content="Create" />
+        </q-btn>
       </q-card-actions>
     </q-card>
   </q-dialog>
@@ -155,6 +208,7 @@ export default {
       optionLayout: true,
       diskfileLayout: false,
       diskblockLayout: false,
+      diskiscsiLayout: false,
       networkLayout: false,
       networkInterfaceTypes: [
         { label: 'VirtIO', value: 'virtio' },
@@ -184,6 +238,12 @@ export default {
       diskBlockBusType: 'virtio',
       diskBlockDeviceType: 'disk',
       diskBlockSource: '',
+      diskIscsiName: '',
+      diskIscsiBusType: 'virtio',
+      diskIscsiDeviceType: 'disk',
+      diskIscsiIqn: '',
+      diskIscsiHost: '',
+      diskIscsiPort: 3260,
     }
   },
   emits: ['finished'],
@@ -199,6 +259,7 @@ export default {
       this.optionLayout = true
       this.diskfileLayout = false
       this.diskblockLayout = false
+      this.diskiscsiLayout = false
       this.networkLayout = false
     },
     optionChose() {
@@ -216,6 +277,15 @@ export default {
         this.diskBlockDeviceType = this.diskDeviceTypes[0]
         this.diskBlockName = ''
         this.diskBlockSource = ''
+      } else if (this.option === 'disk-iscsi') {
+        this.optionLayout = false
+        this.diskiscsiLayout = true
+        this.diskIscsiBusType = this.diskBusTypes[0]
+        this.diskIscsiDeviceType = this.diskDeviceTypes[0]
+        this.diskIscsiName = ''
+        this.diskIscsiIqn = ''
+        this.diskIscsiHost = ''
+        this.diskIscsiPort = 3260
       } else if (this.option === 'network') {
         this.optionLayout = false
         this.networkLayout = true
@@ -294,6 +364,38 @@ export default {
           ])
         })
     },
+    diskIscsiCreate() {
+      if (this.diskIscsiIqn == '') {
+        this.$refs.errorDialog.show('Error', ['iSCSI IQN is required'])
+        return
+      }
+      if (this.diskIscsiHost == '') {
+        this.$refs.errorDialog.show('Error', ['iSCSI Host is required'])
+        return
+      }
+      if (this.diskIscsiName == '') {
+        this.$refs.errorDialog.show('Error', ['Disk name is required'])
+        return
+      }
+      this.$api
+        .post('/vm/' + this.vmid + '/devices/disk-iscsi', {
+          name: this.diskIscsiName,
+          disk_bus: this.diskIscsiBusType.value,
+          device_type: this.diskIscsiDeviceType.value,
+          iscsi_name: this.diskIscsiIqn,
+          iscsi_host: this.diskIscsiHost,
+          iscsi_port: this.diskIscsiPort,
+        })
+        .then(() => {
+          this.layout = false
+          this.$emit('finished')
+        })
+        .catch((error) => {
+          this.$refs.errorDialog.show('Error creating iSCSI device', [
+            error.response?.data?.detail || error.message,
+          ])
+        })
+    },
   },
 }
 </script>
diff --git a/frontend/src/components/vm/EditVmDialog.vue b/frontend/src/components/vm/EditVmDialog.vue
@@ -246,6 +246,34 @@
                           </q-item-label>
                         </q-item-section>
                       </q-item>
+                      <q-item
+                        clickable
+                        v-ripple
+                        v-for="(disk, index) in vm.devices_disk_iscsi"
+                        :key="disk"
+                        :active="disk.active"
+                        @click="deviceSelect('disk-iscsi', disk, index)"
+                      >
+                        <q-item-section thumbnail class="q-pr-sm">
+                          <q-icon
+                            color="primary"
+                            :name="disk.device_type == 'cdrom' ? 'mdi-disc' : 'mdi-harddisk'"
+                          />
+                        </q-item-section>
+                        <q-item-section>
+                          <q-item-label>
+                            {{ disk.disk_bus == 'virtio' ? 'VirtIO' : disk.disk_bus.toUpperCase() }}
+                            {{
+                              disk.device_type == 'cdrom'
+                                ? 'CDROM'
+                                : disk.device_type == 'disk'
+                                  ? 'iSCSI Disk'
+                                  : disk.device_type
+                            }}
+                            {{ disk.index }}
+                          </q-item-label>
+                        </q-item-section>
+                      </q-item>
                       <q-item
                         clickable
                         v-ripple
@@ -316,6 +344,18 @@
                       readonly
                     />
                   </div>
+                  <div v-if="selectedDeviceType == 'disk-iscsi'">
+                    <q-input label="Name" v-model="selectedDevice.name" readonly />
+                    <q-input label="Device Type" v-model="selectedDevice.device_type" readonly />
+                    <q-input label="Disk Bus" v-model="selectedDevice.disk_bus" readonly />
+                    <q-input
+                      label="iSCSI Name (IQN)"
+                      v-model="selectedDevice.iscsi_name"
+                      readonly
+                    />
+                    <q-input label="iSCSI Host" v-model="selectedDevice.iscsi_host" readonly />
+                    <q-input label="iSCSI Port" v-model="selectedDevice.iscsi_port" readonly />
+                  </div>
                   <div v-if="selectedDeviceType == 'network'">
                     <q-input label="Type" v-model="selectedDevice.type" readonly />
                     <q-input
@@ -448,6 +488,9 @@ export default {
         this.vm.devices_disk_block.forEach((element) => {
           element.active = false
         })
+        this.vm.devices_disk_iscsi.forEach((element) => {
+          element.active = false
+        })
       }
     },
     deviceSelect(type, device, index = null) {
@@ -461,6 +504,10 @@ export default {
         this.resetSelectedDevices()
         this.vm.devices_disk_block[index].active = true
         this.selectedDeviceTitle = 'Disk (Block)' + (index + 1)
+      } else if (this.selectedDeviceType == 'disk-iscsi') {
+        this.resetSelectedDevices()
+        this.vm.devices_disk_iscsi[index].active = true
+        this.selectedDeviceTitle = 'Disk (iSCSI) ' + (index + 1)
       } else if (this.selectedDeviceType == 'network') {
         this.resetSelectedDevices()
         this.vm.devices_network[index].active = true
@@ -505,6 +552,15 @@ export default {
           .catch((error) => {
             this.$refs.errorDialog.show('Error deleting disk device', [error.response.data.detail])
           })
+      } else if (this.selectedDeviceType == 'disk-iscsi') {
+        this.$api
+          .delete('/vm/' + this.vmid + '/devices/disk-iscsi/' + this.selectedDevice.id)
+          .then(() => {
+            this.getdata()
+          })
+          .catch((error) => {
+            this.$refs.errorDialog.show('Error deleting iSCSI disk device', [error.response.data.detail])
+          })
       }
     },
     deviceAdd() {
