Updated operating_system and add Proxmox cli information for haos #38746
Conversation
Add KVM/Proxmox cli information
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new section was added to the documentation under the "Hypervisor specific configuration" area, specifically for KVM/Proxmox environments. This addition introduces step-by-step instructions for creating a virtual machine using Proxmox, including a sample command and options for configuring memory, CPU, BIOS, and disk settings. The documentation also explains how to attach a USB dongle to the VM, providing guidance on identifying the dongle's bus and device IDs using the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Proxmox
participant USB Dongle
User ->> Documentation: Reads KVM/Proxmox VM creation instructions
User ->> Proxmox: Runs 'qm create' command with VM parameters
User ->> USB Dongle: Runs 'lsusb' to identify dongle IDs
User ->> Proxmox: Adds USB passthrough option with dongle's vendor/product ID
Proxmox -->> USB Dongle: Attaches USB device to VM
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
source/_includes/installation/operating_system.md (2)
404-405: Consistent title formatting for Proxmox section
To match the style of other hypervisor tabs (e.g., “KVM (virt-install)”), consider renaming the tab title from “KVM/Proxmox” to something like “Proxmox (qm create)”.
407-409: Standardize placeholders and clarify storage identifier
- Use consistent placeholder casing:
<PATH TO QCOW2 FILE>(all uppercase).- Add a note that
<STORAGE>refers to the Proxmox storage ID (for examplelocal-lvm,rbd, or a named storage).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/installation/operating_system.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| {% icon "mdi:alert-outline" %} If you have a USB | ||
| dongle to attach, you need to add the option `--usb<ID> host=busID.deviceId`. You can | ||
| discover these IDs via the `lsusb` command. As example, if `lsusb` output is: | ||
|
|
||
| ```bash | ||
| Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub | ||
| Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub | ||
| Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub | ||
| Bus 001 Device 004: ID 1a86:55d4 QinHeng Electronics SONOFF Zigbee 3.0 USB Dongle Plus V2 | ||
| Bus 001 Device 003: ID 05e3:0610 Genesys Logic, Inc. Hub | ||
| Bus 001 Device 002: ID 05e3:0608 Genesys Logic, Inc. Hub | ||
| Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Correct USB passthrough instructions and syntax
Proxmox expects vendor:product IDs for USB passthrough, not bus.device notation. Also remove the colon after the --usb0 flag. For example:
- {% icon "mdi:alert-outline" %} If you have a USB
- dongle to attach, you need to add the option `--usb<ID> host=busID.deviceId`. You can
- discover these IDs via the `lsusb` command. As example, if `lsusb` output is:
+ {% icon "mdi:alert-outline" %} If you have a USB dongle to attach, add `--usb0 host=vendorID:productID`.
+ You can discover vendor:product IDs with:
+ ```bash
+ lsusb
+ ``` Ensure the user replaces vendorID:productID with the IDs from the ID column in the lsusb output.
| Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID. | ||
| Please check the correct IDs of your USB dongle with `lsusb`. | ||
| {% endunless %} |
There was a problem hiding this comment.
Update note to match Proxmox example
The note still refers to “bus 003, device 003” (from the KVM virt-install example), but for Proxmox we used “Bus 001 Device 004”. Update accordingly to avoid confusion.
- Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID.
+ Note that this configuration (bus 001, device 004) is just an example, your dongle could be on another bus and/or with another device ID.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID. | |
| Please check the correct IDs of your USB dongle with `lsusb`. | |
| {% endunless %} | |
| Note that this configuration (bus 001, device 004) is just an example, your dongle could be on another bus and/or with another device ID. | |
| Please check the correct IDs of your USB dongle with `lsusb`. | |
| {% endunless %} |
|
|
||
| ```bash | ||
| qm create 9999 --name Home Assistent OS --memory 4096 --cores 2 --bios ovmf --machine q35 --ostype l26 --scsihw virtio-scsi-pci --scsi0 nvme:0,import-from=rbnas03-proxmox:import/haos_ova-11.4.qcow2 --boot order=scsi0 --efidisk0 nvme:0,format=raw,efitype=4m,pre-enrolled-keys=1 --serial0 socket --vga serial0 --usb0: host=1a86:55d4 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix VM name typo and flag syntax in example command
- Correct “Home Assistent OS” to “Home Assistant OS”.
- Wrap the VM name in quotes if it contains spaces.
- Remove the colon after
--usb0.
- qm create 9999 --name Home Assistent OS --memory 4096 --cores 2 --bios ovmf --machine q35 --ostype l26 --scsihw virtio-scsi-pci --scsi0 nvme:0,import-from=rbnas03-proxmox:import/haos_ova-11.4.qcow2 --boot order=scsi0 --efidisk0 nvme:0,format=raw,efitype=4m,pre-enrolled-keys=1 --serial0 socket --vga serial0 --usb0: host=1a86:55d4
+ qm create 9999 --name "Home Assistant OS" --memory 4096 --cores 2 --bios ovmf --machine q35 \
+ --ostype l26 --scsihw virtio-scsi-pci --scsi0 nvme:0,import-from=rbnas03-proxmox:import/haos_ova-11.4.qcow2 \
+ --boot order=scsi0 --efidisk0 nvme:0,format=raw,efitype=4m,pre-enrolled-keys=1 \
+ --serial0 socket --vga serial0 --usb0 host=1a86:55d4📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```bash | |
| qm create 9999 --name Home Assistent OS --memory 4096 --cores 2 --bios ovmf --machine q35 --ostype l26 --scsihw virtio-scsi-pci --scsi0 nvme:0,import-from=rbnas03-proxmox:import/haos_ova-11.4.qcow2 --boot order=scsi0 --efidisk0 nvme:0,format=raw,efitype=4m,pre-enrolled-keys=1 --serial0 socket --vga serial0 --usb0: host=1a86:55d4 | |
| ``` |
|
This was already tried with #37997, but postponed after the current hardware platform and installation method deprecations are agreed and rolled out. |
Proposed change
Add Proxmox CLI information
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit