Enhance README with multi-distro and custom image info#16
Enhance README with multi-distro and custom image info#16genedna merged 1 commit intobuck2hub:mainfrom
Conversation
Add multi-distribution support details and usage examples for Ubuntu, Fedora, and Arch Linux. Include custom image creation instructions with checksum verification.
jjl9807
left a comment
jjl9807
left a comment
There was a problem hiding this comment.
None of the Quick Start examples documented for different distributions (Ubuntu, Fedora, Arch) are functional:
- Ubuntu: Fails to establish vsock connectivity after initialization; manual debugging reveals "Connection closed by UNKNOWN port" errors.
- Fedora & Arch: Initialization fails entirely—sysroot cannot be mounted and the system drops into emergency mode, indicating a broken initrd.
This documentation update is completely untested and misleading. Submitting instructions that fail across ALL listed distributions demonstrates a total disregard for basic validation. After your previous submission of untested code, this repeat negligence is unacceptable.
@userhaptop Stop polluting the project repository immediately!
| ```rust | ||
| use anyhow::Result; | ||
| use qlean::{Distro, create_image, MachineConfig, with_machine}; | ||
|
|
||
| #[tokio::test] | ||
| async fn test_ubuntu_vm() -> Result<()> { | ||
| // Ubuntu - WSL friendly, no guestfish required | ||
| let image = create_image(Distro::Ubuntu, "ubuntu-noble-cloudimg").await?; | ||
| let config = MachineConfig::default(); | ||
|
|
||
| with_machine(&image, &config, |vm| { | ||
| Box::pin(async { | ||
| let result = vm.exec("lsb_release -a").await?; | ||
| assert!(result.status.success()); | ||
| Ok(()) | ||
| }) | ||
| }) | ||
| .await?; | ||
|
|
||
| Ok(()) | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Did you bother to run this example before submitting?
|
|
||
| - 🔗 **Flexible Sources**: Download from URL or use local qcow2 files | ||
| - 🔒 **Security First**: Mandatory SHA-256/SHA-512 checksum verification | ||
| - 🪟 **WSL Compatible**: Optional pre-extracted kernel/initrd mode |
There was a problem hiding this comment.
What exactly were you planning to put here—an emoji?
| } | ||
| ``` | ||
|
|
||
| > **💡 Tip**: Ubuntu is the recommended distribution for WSL users as it doesn't require guestfish for boot file extraction. |
There was a problem hiding this comment.
What motivated the focus on WSL compatibility here? Did you encounter a specific runtime issue under WSL? If so, please share details.
3 participants
Add multi-distribution support details and usage examples for Ubuntu, Fedora, and Arch Linux. Include custom image creation instructions with checksum verification.